Struct google_apigee1::api::GoogleCloudApigeeV1ApiDoc

pub struct GoogleCloudApigeeV1ApiDoc {

    pub anon_allowed: Option<bool>,
    pub api_product_name: Option<String>,
    pub category_ids: Option<Vec<String>>,
    pub description: Option<String>,
    pub edge_api_product_name: Option<String>,
    pub graphql_endpoint_url: Option<String>,
    pub graphql_schema: Option<String>,
    pub graphql_schema_display_name: Option<String>,
    pub id: Option<i64>,
    pub image_url: Option<String>,
    pub modified: Option<i64>,
    pub published: Option<bool>,
    pub require_callback_url: Option<bool>,
    pub site_id: Option<String>,
    pub spec_id: Option<String>,
    pub title: Option<String>,
    pub visibility: Option<bool>,
}

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. Through this link, portal users can create and manage developer apps linked to one or more API products.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• sites apidocs create organizations (request)
• sites apidocs update organizations (request)

Fields

anon_allowed: Option<bool>

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: Option<String>

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: Option<Vec<String>>

Optional. The IDs of the API categories to which this catalog item belongs.

description: Option<String>

Optional. Description of the catalog item. Max length is 10,000 characters.

edge_api_product_name: Option<String>

Optional. Immutable. DEPRECATED: use the apiProductName field instead

graphql_endpoint_url: Option<String>

Optional. DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods

graphql_schema: Option<String>

Optional. DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods

graphql_schema_display_name: Option<String>

Optional. DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods

id: Option<i64>

Output only. The ID of the catalog item.

image_url: Option<String>

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: Option<i64>

Output only. Time the catalog item was last modified in milliseconds since epoch.

published: Option<bool>

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: Option<bool>

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: Option<String>

Output only. The ID of the parent portal.

spec_id: Option<String>

Optional. DEPRECATED: DO NOT USE

title: Option<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: Option<bool>

Optional. DEPRECATED: use the published field instead

Trait Implementations

impl Clone for GoogleCloudApigeeV1ApiDoc

fn clone(&self) -> GoogleCloudApigeeV1ApiDoc

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GoogleCloudApigeeV1ApiDoc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GoogleCloudApigeeV1ApiDoc

fn default() -> GoogleCloudApigeeV1ApiDoc

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GoogleCloudApigeeV1ApiDoc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GoogleCloudApigeeV1ApiDoc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for GoogleCloudApigeeV1ApiDoc