ApiNotes · Schema

ApiNotes Documentation

Schema representing an API documentation portal generated by ApiNotes from an OpenAPI specification

API ReferenceDeveloper PortalDocumentationInteractiveOpenAPI

Name	Type	Description
id	string	Unique identifier for the documentation portal
name	string	Name of the API documentation portal
description	string	Description of the API being documented
specificationUrl	string	URL of the OpenAPI or Swagger specification used to generate documentation
portalUrl	string	Public URL of the generated documentation portal
version	string	API version being documented
languages	array	Programming languages for which code examples are generated
liveTestingEnabled	boolean	Whether live endpoint testing is enabled in the portal
createdAt	string	Timestamp when the documentation was generated