Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ApiSummary

A summary of the API.

Properties

compartmentId

compartmentId: string

The OCID of the compartment in which the resource is created.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: {@code My new resource}

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the resource.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are:

  • 'New' for just updated API Specifications
  • 'Validating' for a document which is being validated.
  • 'Valid' the document has been validated without any errors or warnings
  • 'Warning' the document has been validated and contains warnings
  • 'Error' the document has been validated and contains errors
  • 'Failed' the document validation failed
  • 'Canceled' the document validation was canceled

    For other states it may provide more details like actionable information.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the API.

Optional specificationType

specificationType: undefined | string

Type of API Specification file.

Optional timeCreated

timeCreated: Date

The time this resource was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time this resource was last updated. An RFC3339 formatted datetime string.

Optional validationResults

validationResults: Array<ApiValidationResult>

Status of each feature available from the API.

Functions

getDeserializedJsonObj

getJsonObj