close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new catalog item.

Args:
parent: string, Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}` (required)
body: object, The request body.
The object takes the form of:

{ # `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 `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.
"anonAllowed": True or False, # 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 the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). 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": "A String", # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
"categoryIds": [ # Optional. The IDs of the API categories to which this catalog item belongs.
"A String",
],
"description": "A String", # Optional. Description of the catalog item. Max length is 10,000 characters.
"edgeAPIProductName": "A String", # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
"graphqlEndpointUrl": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchema": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchemaDisplayName": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"id": "A String", # Output only. The ID of the catalog item.
"imageUrl": "A String", # 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 for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files"), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won't be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
"modified": "A String", # Output only. Time the catalog item was last modified in milliseconds since epoch.
"published": True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
"requireCallbackUrl": True or False, # 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).
"siteId": "A String", # Output only. The ID of the parent portal.
"specId": "A String", # Optional. DEPRECATED: DO NOT USE
"title": "A String", # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
"visibility": True or False, # Optional. DEPRECATED: use the `published` field instead
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The catalog item resource wrapped with response status, error_code, etc.
"data": { # `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 `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products. # The catalog item resource.
"anonAllowed": True or False, # 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 the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). 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": "A String", # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
"categoryIds": [ # Optional. The IDs of the API categories to which this catalog item belongs.
"A String",
],
"description": "A String", # Optional. Description of the catalog item. Max length is 10,000 characters.
"edgeAPIProductName": "A String", # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
"graphqlEndpointUrl": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchema": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchemaDisplayName": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"id": "A String", # Output only. The ID of the catalog item.
"imageUrl": "A String", # 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 for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files"), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won't be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
"modified": "A String", # Output only. Time the catalog item was last modified in milliseconds since epoch.
"published": True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
"requireCallbackUrl": True or False, # 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).
"siteId": "A String", # Output only. The ID of the parent portal.
"specId": "A String", # Optional. DEPRECATED: DO NOT USE
"title": "A String", # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
"visibility": True or False, # Optional. DEPRECATED: use the `published` field instead
},
"errorCode": "A String", # Unique error code for the request, if any.
"message": "A String", # Description of the operation.
"requestId": "A String", # Unique ID of the request.
"status": "A String", # Status of the operation.
}

delete(name, x__xgafv=None)

Deletes a catalog item.

Args:
  name: string, Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for certain delete operations.
  "errorCode": "A String", # Unique error code for the request, if any.
  "gcpResource": "A String", # Google Cloud name of deleted resource.
  "message": "A String", # Description of the operation.
  "requestId": "A String", # Unique ID of the request.
  "status": "A String", # Status of the operation.
}

get(name, x__xgafv=None)

Gets a catalog item.

Args:
name: string, Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The catalog item resource wrapped with response status, error_code, etc.
"data": { # `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 `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products. # The catalog item resource.
"anonAllowed": True or False, # 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 the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). 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": "A String", # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
"categoryIds": [ # Optional. The IDs of the API categories to which this catalog item belongs.
"A String",
],
"description": "A String", # Optional. Description of the catalog item. Max length is 10,000 characters.
"edgeAPIProductName": "A String", # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
"graphqlEndpointUrl": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchema": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchemaDisplayName": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"id": "A String", # Output only. The ID of the catalog item.
"imageUrl": "A String", # 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 for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files"), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won't be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
"modified": "A String", # Output only. Time the catalog item was last modified in milliseconds since epoch.
"published": True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
"requireCallbackUrl": True or False, # 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).
"siteId": "A String", # Output only. The ID of the parent portal.
"specId": "A String", # Optional. DEPRECATED: DO NOT USE
"title": "A String", # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
"visibility": True or False, # Optional. DEPRECATED: use the `published` field instead
},
"errorCode": "A String", # Unique error code for the request, if any.
"message": "A String", # Description of the operation.
"requestId": "A String", # Unique ID of the request.
"status": "A String", # Status of the operation.
}

getDocumentation(name, x__xgafv=None)

Gets the documentation for the specified catalog item.

Args:
  name: string, Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The catalog item documentation wrapped with response status, error_code, etc.
  "data": { # The documentation for a catalog item. # Output only. The documentation resource.
    "graphqlDocumentation": { # GraphQL documentation for a catalog item. # Optional. GraphQL documentation.
      "endpointUri": "A String", # Required. The GraphQL endpoint URI to be queried by API consumers. Max length is 2,083 characters.
      "schema": { # Documentation file contents for a catalog item. # Required. The documentation file contents for the GraphQL schema.
        "contents": "A String", # Required. The file contents. The max size is 4 MB.
        "displayName": "A String", # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
      },
    },
    "oasDocumentation": { # OpenAPI Specification documentation for a catalog item. # Optional. OpenAPI Specification documentation.
      "format": "A String", # Output only. The format of the input specification file contents.
      "spec": { # Documentation file contents for a catalog item. # Required. The documentation file contents for the OpenAPI Specification. JSON and YAML file formats are supported.
        "contents": "A String", # Required. The file contents. The max size is 4 MB.
        "displayName": "A String", # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
      },
    },
  },
  "errorCode": "A String", # Output only. Unique error code for the request, if any.
  "message": "A String", # Output only. Description of the operation.
  "requestId": "A String", # Output only. Unique ID of the request.
  "status": "A String", # Output only. Status of the operation.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Returns the catalog items associated with a portal.

Args:
parent: string, Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}` (required)
pageSize: integer, Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 25 books will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken: string, Optional. A page token, received from a previous `ListApiDocs` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{
"data": [ # The catalog item resources.
{ # `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 `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.
"anonAllowed": True or False, # 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 the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). 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": "A String", # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
"categoryIds": [ # Optional. The IDs of the API categories to which this catalog item belongs.
"A String",
],
"description": "A String", # Optional. Description of the catalog item. Max length is 10,000 characters.
"edgeAPIProductName": "A String", # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
"graphqlEndpointUrl": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchema": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchemaDisplayName": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"id": "A String", # Output only. The ID of the catalog item.
"imageUrl": "A String", # 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 for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files"), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won't be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
"modified": "A String", # Output only. Time the catalog item was last modified in milliseconds since epoch.
"published": True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
"requireCallbackUrl": True or False, # 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).
"siteId": "A String", # Output only. The ID of the parent portal.
"specId": "A String", # Optional. DEPRECATED: DO NOT USE
"title": "A String", # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
"visibility": True or False, # Optional. DEPRECATED: use the `published` field instead
},
],
"errorCode": "A String", # Unique error code for the request, if any.
"message": "A String", # Description of the operation.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"requestId": "A String", # Unique ID of the request.
"status": "A String", # Status of the operation.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

update(name, body=None, x__xgafv=None)

Updates a catalog item.

Args:
name: string, Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}` (required)
body: object, The request body.
The object takes the form of:

{ # `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 `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.
"anonAllowed": True or False, # 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 the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). 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": "A String", # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
"categoryIds": [ # Optional. The IDs of the API categories to which this catalog item belongs.
"A String",
],
"description": "A String", # Optional. Description of the catalog item. Max length is 10,000 characters.
"edgeAPIProductName": "A String", # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
"graphqlEndpointUrl": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchema": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchemaDisplayName": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"id": "A String", # Output only. The ID of the catalog item.
"imageUrl": "A String", # 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 for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files"), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won't be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
"modified": "A String", # Output only. Time the catalog item was last modified in milliseconds since epoch.
"published": True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
"requireCallbackUrl": True or False, # 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).
"siteId": "A String", # Output only. The ID of the parent portal.
"specId": "A String", # Optional. DEPRECATED: DO NOT USE
"title": "A String", # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
"visibility": True or False, # Optional. DEPRECATED: use the `published` field instead
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The catalog item resource wrapped with response status, error_code, etc.
"data": { # `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 `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products. # The catalog item resource.
"anonAllowed": True or False, # 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 the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). 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": "A String", # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
"categoryIds": [ # Optional. The IDs of the API categories to which this catalog item belongs.
"A String",
],
"description": "A String", # Optional. Description of the catalog item. Max length is 10,000 characters.
"edgeAPIProductName": "A String", # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
"graphqlEndpointUrl": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchema": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"graphqlSchemaDisplayName": "A String", # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
"id": "A String", # Output only. The ID of the catalog item.
"imageUrl": "A String", # 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 for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files"), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won't be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
"modified": "A String", # Output only. Time the catalog item was last modified in milliseconds since epoch.
"published": True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_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 (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
"requireCallbackUrl": True or False, # 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).
"siteId": "A String", # Output only. The ID of the parent portal.
"specId": "A String", # Optional. DEPRECATED: DO NOT USE
"title": "A String", # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
"visibility": True or False, # Optional. DEPRECATED: use the `published` field instead
},
"errorCode": "A String", # Unique error code for the request, if any.
"message": "A String", # Description of the operation.
"requestId": "A String", # Unique ID of the request.
"status": "A String", # Status of the operation.
}

updateDocumentation(name, body=None, x__xgafv=None)

Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

Args:
  name: string, Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation` (required)
  body: object, The request body.
    The object takes the form of:

{ # The documentation for a catalog item.
  "graphqlDocumentation": { # GraphQL documentation for a catalog item. # Optional. GraphQL documentation.
    "endpointUri": "A String", # Required. The GraphQL endpoint URI to be queried by API consumers. Max length is 2,083 characters.
    "schema": { # Documentation file contents for a catalog item. # Required. The documentation file contents for the GraphQL schema.
      "contents": "A String", # Required. The file contents. The max size is 4 MB.
      "displayName": "A String", # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
    },
  },
  "oasDocumentation": { # OpenAPI Specification documentation for a catalog item. # Optional. OpenAPI Specification documentation.
    "format": "A String", # Output only. The format of the input specification file contents.
    "spec": { # Documentation file contents for a catalog item. # Required. The documentation file contents for the OpenAPI Specification. JSON and YAML file formats are supported.
      "contents": "A String", # Required. The file contents. The max size is 4 MB.
      "displayName": "A String", # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The catalog item documentation wrapped with response status, error_code, etc.
  "data": { # The documentation for a catalog item. # Output only. The documentation resource.
    "graphqlDocumentation": { # GraphQL documentation for a catalog item. # Optional. GraphQL documentation.
      "endpointUri": "A String", # Required. The GraphQL endpoint URI to be queried by API consumers. Max length is 2,083 characters.
      "schema": { # Documentation file contents for a catalog item. # Required. The documentation file contents for the GraphQL schema.
        "contents": "A String", # Required. The file contents. The max size is 4 MB.
        "displayName": "A String", # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
      },
    },
    "oasDocumentation": { # OpenAPI Specification documentation for a catalog item. # Optional. OpenAPI Specification documentation.
      "format": "A String", # Output only. The format of the input specification file contents.
      "spec": { # Documentation file contents for a catalog item. # Required. The documentation file contents for the OpenAPI Specification. JSON and YAML file formats are supported.
        "contents": "A String", # Required. The file contents. The max size is 4 MB.
        "displayName": "A String", # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
      },
    },
  },
  "errorCode": "A String", # Output only. Unique error code for the request, if any.
  "message": "A String", # Output only. Description of the operation.
  "requestId": "A String", # Output only. Unique ID of the request.
  "status": "A String", # Output only. Status of the operation.
}

Apigee API . organizations . sites . apidocs

Instance Methods

Method Details