Updates a catalog item.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: apigee1 --scope <scope> organizations sites-apidocs-update ...

Required Scalar Argument

• <name> (string)
  • Required. Name of the catalog item. Use the following structure in your request: organizations/{org}/sites/{site}/apidocs/{apidoc}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudApigeeV1ApiDoc:
  anon-allowed: boolean
  api-product-name: string
  category-ids: [string]
  description: string
  edge-api-product-name: string
  graphql-endpoint-url: string
  graphql-schema: string
  graphql-schema-display-name: string
  id: string
  image-url: string
  modified: string
  published: boolean
  require-callback-url: boolean
  site-id: string
  spec-id: string
  title: string
  visibility: boolean

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . anon-allowed=false
  • Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the audience management feature, this flag is ignored; instead visibility must be further managed in the management UI (see Manage the visibility of an API in your portal).
• api-product-name=ut
  • Required. Immutable. The name field of the associated API product. A portal may have only one catalog item associated with a given API product.
• category-ids=consetetur
  • Optional. The IDs of the API categories to which this catalog item belongs.
  • Each invocation of this argument appends the given value to the array.
• description=at
  • Optional. Description of the catalog item. Max length is 10,000 characters.
• edge-api-product-name=et
  • Optional. Immutable. DEPRECATED: use the apiProductName field instead
• graphql-endpoint-url=dolor
  • Optional. DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods
• graphql-schema=clita
  • Optional. DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods
• graphql-schema-display-name=tempor
  • Optional. DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods
• id=amet
  • Output only. The ID of the catalog item.
• image-url=dolor
  • 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=dolore
  • Output only. Time the catalog item was last modified in milliseconds since epoch.
• published=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, the visibility must be 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 further managed by the anonAllowed flag.
• require-callback-url=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).
• site-id=lorem
  • Output only. The ID of the parent portal.
• spec-id=sed
  • Optional. DEPRECATED: DO NOT USE
• title=tempor
  • Required. The user-facing name of the catalog item. title must be a non-empty string with a max length of 255 characters.
• visibility=false
  • Optional. DEPRECATED: use the published field instead

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").