DeployedApiComponentMetadata

Metadata information for a deployed API component including title, version, description, and routing details.

type DeployedApiComponentMetadata {
  title: String
  version: String
  description: String
  publisher: DeployedApiComponentPublisher
  license: DeployedApiComponentLicense
  routes: [DeployedApiComponentRoute!]
  apiProxyServerUrl: String
  apiPackagedComponentVersion: String
  componentType: ComponentType
}

Fields

DeployedApiComponentMetadata.title ● String scalar miscellaneous {#title}

The title or name of the API component.

DeployedApiComponentMetadata.version ● String scalar miscellaneous {#version}

The version number of the API component.

DeployedApiComponentMetadata.description ● String scalar miscellaneous {#description}

A description of the API component's functionality and purpose.

DeployedApiComponentMetadata.publisher ● DeployedApiComponentPublisher object platform {#publisher}

Publisher information for the API component.

DeployedApiComponentMetadata.license ● DeployedApiComponentLicense object platform {#license}

License information for the API component.

DeployedApiComponentMetadata.routes ● [DeployedApiComponentRoute!] list object platform {#routes}

List of route configurations for the API component.

DeployedApiComponentMetadata.apiProxyServerUrl ● String scalar miscellaneous {#api-proxy-server-url}

The URL of the API proxy server for this component.

DeployedApiComponentMetadata.apiPackagedComponentVersion ● String scalar miscellaneous {#api-packaged-component-version}

The version of the packaged component.

DeployedApiComponentMetadata.componentType ● ComponentType enum platform {#component-type}

The type of component.

Member Of

ApiLifecycle object ●  DeployedApi object