REST Resource: organizations.sites.apidocs

Resource: ApiDocBody

JSON representation
{
  "siteId": string,
  "title": string,
  "description": string,
  "visibility": boolean,
  "enrollment": string,
  "apiId": string,
  "edgeAPIProductName": string,
  "specId": string,
  "specContent": string,
  "specTitle": string,
  "snapshotExists": boolean,
  "snapshotModified": string,
  "modified": string,
  "anonAllowed": boolean,
  "imageUrl": string,
  "snapshotState": enum (SnapshotState),
  "productExists": boolean,
  "specModified": string,
  "snapshotOutdated": boolean,
  "snapshotSourceMissing": boolean,
  "id": string,
  "requireCallbackUrl": boolean
}
Fields
siteId

string

Name of the portal.

title

string

Title of the API.

description

string

Description of the API.

visibility

boolean

Boolean flag that specifies whether the API is visible to all users (public).

enrollment

string

Not used by Apigee hybrid.

apiId

string

ID of the API.

edgeAPIProductName

string

Name of the associated API product.

specId

string

ID of the OpenAPI Specification.

specContent

string

OpenAPI Specification content.

specTitle

string

Title of the OpenAPI Specification.

snapshotExists

boolean

Boolean flag that specifies whether a snapshot of the OpenAPI Specification that is used to render API reference documentation exists.

snapshotModified

string (int64 format)

Time the snapshot of the OpenAPI Specification was last modified in milliseconds since epoch.

modified

string (int64 format)

Time the API was last modified in milliseconds since epoch.

anonAllowed

boolean

Boolean flag that specifies whether all or only registered users can access the API.

imageUrl

string

URL of the image used for the API in the API catalog.

snapshotState

enum (SnapshotState)

Status of the snapshot of the OpenAPI Specification that is used to render API reference documentation.

productExists

boolean

Boolean flag that specifies whether the API product exists.

specModified

string (int64 format)

Time the OpenAPI Specification was last modified in milliseconds since epoch.

snapshotOutdated

boolean

Boolean flag that specifies whether the snapshot of the OpenAPI Specification is out of date.

snapshotSourceMissing

boolean

Boolean flag that specifies whether the snapshot of the OpenAPI Specification is missing.

id

string (int64 format)

ID of the API.

requireCallbackUrl

boolean

Boolean flag that specifies whether a callback URL is required.

SnapshotState

Status of the snapshot of the OpenAPI Specification that is used to render API reference documentation.

Enums
SNAPSHOT_STATE_UNSPECIFIED
MISSING Snapshot is missing.
OK_DOCSTORE Snapshot uploaded from spec store.
OK_SUBMITTED Snapshot uploaded from local directory.
OK_EXTERNAL Snapshot imported from an external URL.
DELETED Snapshot deleted.

Methods

create

Publishes an API to the portal.

delete

Removes a published API from the portal.

deleteSnapshot

Removes the current OpenAPI Specification snapshot from the published API.

get

Gets the details for a published API.

list

Lists the details for all published APIs.

listPublishableProducts

Lists the APIs that can be published to the portal.

snapshot

Uploads the contents of an OpenAPI Specification snapshot for a published API.

update

Updates the details or specification for a published API.