REST Resource: organizations.sites.apidocs
Resource: ApiDoc
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
apiProductNamefield provides a link to a backingAPI product. Through this link, portal users can create and manage developer apps linked to one or more API products.
| JSON representation |
|---|
{"siteId":string,"id":string,"title":string,"description":string,"published":boolean,"anonAllowed":boolean,"apiProductName":string,"requireCallbackUrl":boolean,"imageUrl":string,"categoryIds":[string],"modified":string,"visibility":boolean,"edgeAPIProductName":string,"specId":string,"graphqlSchema":string,"graphqlEndpointUrl":string,"graphqlSchemaDisplayName":string} |
| Fields | |
|---|---|
siteId |
Output only. The ID of the parent portal. |
id |
Output only. The ID of the catalog item. |
title |
Required. The user-facing name of the catalog item. |
description |
Optional. Description of the catalog item. Max length is 10,000 characters. |
published |
Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in theaudience management feature, the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (seeManage the visibility of an API in your portal) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the |
anonAllowed |
Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in theaudience management feature, and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (seeManage the visibility of an API in your portal). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI. |
apiProductName |
Required. Immutable. The |
requireCallbackUrl |
Optional. Whether a callback URL is required when this catalog item's API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app's OAuth flow). |
imageUrl |
Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path forimage files stored in the portal, for example, |
categoryIds[] |
Optional. The IDs of the API categories to which this catalog item belongs. |
modified |
Output only. Time the catalog item was last modified in milliseconds since epoch. |
visibility |
Optional. DEPRECATED: use the |
edgeAPIProductName |
Optional. Immutable. DEPRECATED: use the |
specId |
This item is deprecated! Optional. DEPRECATED: DO NOT USE |
graphqlSchema |
This item is deprecated! Optional. DEPRECATED: manage documentation through the |
graphqlEndpointUrl |
This item is deprecated! Optional. DEPRECATED: manage documentation through the |
graphqlSchemaDisplayName |
This item is deprecated! Optional. DEPRECATED: manage documentation through the |
Methods | |
|---|---|
| Creates a new catalog item. |
| Deletes a catalog item. |
| Gets a catalog item. |
| Gets the documentation for the specified catalog item. |
| Returns the catalog items associated with a portal. |
| Updates a catalog item. |
| Updates the documentation for the specified catalog item. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-15 UTC.