API Catalog API
ApiDoc
represents an API catalog item. Catalog items are used in two ways in a portal:
- Users can browse and interact with a visual representation of the API documentation.
- The
apiProductName
field provides a link to a backing API product. Through this link, portal users can create and manage developer apps linked to one or more API products.
For more information, see Publish your APIs.
Resource Types
ApiDoc
Method | Endpoint | Description |
---|---|---|
get | /organizations/{org}/sites/{site}/apidocs | List the catalog items associated with a portal. |
post | /organizations/{org}/sites/{site}/apidocs | Creates a catalog item. |
get | /organizations/{org}/sites/{site}/apidocs/{apidoc} | Gets a catalog item. |
put | /organizations/{org}/sites/{site}/apidocs/{apidoc} | Updates a catalog item. |
ApiDocDocumentation
Method | Endpoint | Description |
---|---|---|
get | /organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation | Gets the documentation for the specified catalog item. |
patch | /organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation | Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message. |
ApiDocDocumentionResponse
Method | Endpoint | Description |
---|---|---|
get | /organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation | Gets the documentation for the specified catalog item. |
patch | /organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation | Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message. |
ApiDocListResponse
Method | Endpoint | Description |
---|---|---|
get | /organizations/{org}/sites/{site}/apidocs | List the catalog items associated with a portal. |
ApiDocRequest
Method | Endpoint | Description |
---|---|---|
post | /organizations/{org}/sites/{site}/apidocs | Creates a catalog item. |
put | /organizations/{org}/sites/{site}/apidocs/{apidoc} | Updates a catalog item. |
ApiDocResponse
Method | Endpoint | Description |
---|---|---|
post | /organizations/{org}/sites/{site}/apidocs | Creates a catalog item. |
get | /organizations/{org}/sites/{site}/apidocs/{apidoc} | Gets a catalog item. |
put | /organizations/{org}/sites/{site}/apidocs/{apidoc} | Updates a catalog item. |
DeleteResponse
Method | Endpoint | Description |
---|---|---|
delete | /organizations/{org}/sites/{site}/apidocs/{apidoc} | Deletes a catalog item. |
DocumentationFile
Method | Endpoint | Description |
---|---|---|
get | /organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation | Gets the documentation for the specified catalog item. |
patch | /organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation | Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message. |
GraphqlDocumentation
Method | Endpoint | Description |
---|---|---|
get | /organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation | Gets the documentation for the specified catalog item. |
patch | /organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation | Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message. |
OASDocumentation
Method | Endpoint | Description |
---|---|---|
get | /organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation | Gets the documentation for the specified catalog item. |
patch | /organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation | Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message. |