Apigee · Schema

ApiVersion

A version of an API.

Advanced API SecurityAgentic AIAnalyticsAPI GatewayAPI GovernanceAPI HubAPI ManagementDeveloper PortalEnterpriseGenerative AIHybridIntegrationsMicroservicesMCPModel Context ProtocolMonetization

Properties

Name Type Description
name string Output only. Resource name of the version.
displayName string Required. Display name for the version.
description string Description of the API version.
documentation object
specs array Output only. Specs associated with this version.
apiOperations array Output only. Operations associated with this version.
definitions array Output only. Definitions associated with this version.
deployments array Output only. Deployments associated with this version.
lifecycle object
compliance object
accreditation object
attributes object Custom attributes associated with this version.
createTime string Output only. Time the version was created.
updateTime string Output only. Time the version was last updated.
View JSON Schema on GitHub

JSON Schema

apigee-apiversion-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiVersion",
  "title": "ApiVersion",
  "type": "object",
  "description": "A version of an API.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Output only. Resource name of the version.",
      "readOnly": true
    },
    "displayName": {
      "type": "string",
      "description": "Required. Display name for the version."
    },
    "description": {
      "type": "string",
      "description": "Description of the API version."
    },
    "documentation": {
      "$ref": "#/components/schemas/Documentation"
    },
    "specs": {
      "type": "array",
      "description": "Output only. Specs associated with this version.",
      "readOnly": true,
      "items": {
        "type": "string"
      }
    },
    "apiOperations": {
      "type": "array",
      "description": "Output only. Operations associated with this version.",
      "readOnly": true,
      "items": {
        "type": "string"
      }
    },
    "definitions": {
      "type": "array",
      "description": "Output only. Definitions associated with this version.",
      "readOnly": true,
      "items": {
        "type": "string"
      }
    },
    "deployments": {
      "type": "array",
      "description": "Output only. Deployments associated with this version.",
      "readOnly": true,
      "items": {
        "type": "string"
      }
    },
    "lifecycle": {
      "$ref": "#/components/schemas/AttributeValues"
    },
    "compliance": {
      "$ref": "#/components/schemas/AttributeValues"
    },
    "accreditation": {
      "$ref": "#/components/schemas/AttributeValues"
    },
    "attributes": {
      "type": "object",
      "description": "Custom attributes associated with this version.",
      "additionalProperties": {
        "$ref": "#/components/schemas/AttributeValues"
      }
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "Output only. Time the version was created.",
      "readOnly": true
    },
    "updateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Output only. Time the version was last updated.",
      "readOnly": true
    }
  }
}