View Source GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc (google_api_apigee v0.46.0)

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.

Attributes

  • anonAllowed (type: boolean(), default: nil) - 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, 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). 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 (type: String.t, default: nil) - Required. Immutable. The name field of the associated API product. A portal may have only one catalog item associated with a given API product.
  • categoryIds (type: list(String.t), default: nil) - Optional. The IDs of the API categories to which this catalog item belongs.
  • description (type: String.t, default: nil) - Optional. Description of the catalog item. Max length is 10,000 characters.
  • edgeAPIProductName (type: String.t, default: nil) - Optional. Immutable. DEPRECATED: use the apiProductName field instead
  • graphqlEndpointUrl (type: String.t, default: nil) - Optional. DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods
  • graphqlSchema (type: String.t, default: nil) - Optional. DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods
  • graphqlSchemaDisplayName (type: String.t, default: nil) - Optional. DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods
  • id (type: String.t, default: nil) - Output only. The ID of the catalog item.
  • imageUrl (type: String.t, default: nil) - Optional. Location of the image used for the catalog item in the catalog. For portal files, this can have the format /files/{filename}. Max length is 2,083 characters.
  • modified (type: String.t, default: nil) - Output only. Time the catalog item was last modified in milliseconds since epoch.
  • published (type: boolean(), default: nil) - 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, 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) 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 (type: boolean(), default: nil) - 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 (type: String.t, default: nil) - Output only. The ID of the parent portal.
  • specId (type: String.t, default: nil) - Optional. DEPRECATED: DO NOT USE
  • title (type: String.t, default: nil) - Required. The user-facing name of the catalog item. title must be a non-empty string with a max length of 255 characters.
  • visibility (type: boolean(), default: nil) - Optional. DEPRECATED: use the published field instead

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

Link to this type

t()

View Source 
@type t() :: %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc{
  anonAllowed: boolean() | nil,
  apiProductName: String.t() | nil,
  categoryIds: [String.t()] | nil,
  description: String.t() | nil,
  edgeAPIProductName: String.t() | nil,
  graphqlEndpointUrl: String.t() | nil,
  graphqlSchema: String.t() | nil,
  graphqlSchemaDisplayName: String.t() | nil,
  id: String.t() | nil,
  imageUrl: String.t() | nil,
  modified: String.t() | nil,
  published: boolean() | nil,
  requireCallbackUrl: boolean() | nil,
  siteId: String.t() | nil,
  specId: String.t() | nil,
  title: String.t() | nil,
  visibility: boolean() | nil
}

Functions

Link to this function

decode(value, options)

View Source 
@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.