Metadata APIs
The vapi metadata package provides metadata services. These are services that provide different facets of API information. Clients can use these services to: - Discover APIs available in the infrastructure. - Fetch metadata that can be used to build presentation layers like CLI, REST, etc. - Fetch authentication and authorization metadata.
Resources
Authentication
Component
The Component service provides operations to retrieve authentication information of a component element. A component element is said to contain authentication information if any one of package elements contained in it has authentication information.
Package
The Package service provides operations to retrieve authentication information of a package element. A package element is said to contain authentication information if there is a default authentication assigned to all service elements contained in the package element or if one of the service element contained in this package element has authentication information.
Service
The Service service provides operations to retrieve authentication information of a service element. A service element is said to contain authentication information if there is a default authentication assigned to all operation elements contained in a service element or if one of the operation elements contained in this service element has authentication information.
Authentication Service
Operation
The Operation service provides operations to retrieve authentication information of an operation element. An operation element is said to contain authentication information if authentication schemes are specified in the authentication definition file.
CLI
Command
The Command service provides operations to get information about command line interface (CLI) commands.
Namespace
The Namespace service provides operations to get information about command line interface (CLI) namespaces.
Metamodel
Component
The Component service providers operations to retrieve metamodel information of a component element. A component defines a set of functionality that is deployed together and versioned together. For example, all the services that belong to VMware Content Library are part of a single component. A component element describes a component. A component element contains one or more package elements.
The operations for package elements are provided by service Package.
Enumeration
The Enumeration service provides operations to retrieve metamodel information about an enumeration element in the interface definition language. The Enumeration has a list of enumeration value elements.
Package
The Package service provides operations to retrieve metamodel information about a package element in the interface definition language. A package is a logical grouping of services, structures and enumerations. A package element describes the package. It contains the service elements, structure elements and enumeration elements that are grouped together.
Resource
The Resource service provides operations to retrieve information about resource types. A service is a logical grouping of operations that operate on an entity. Each entity is identifier by a namespace (or resource type) and an unique identifier.
Service
The Service service provides operations to retrieve metamodel information about a service element in the interface definition language. A service is a logical grouping of operations that operate on some entity. A service element describes a service. It contains operation elements that describe the operations grouped in the service. It also contains structure elements and enumeration elements corresponding to the structures and enumerations defined in the service.
Structure
The Structure service providers operations to retrieve metamodel information about a structure element in the interface definition language.
Metamodel Resource
Model
The Model service provides operations to retrieve information about models. A structure is used as a model if it is used for persisting data about an entity. Some of the fields in the model structure are also used for creating indexes for querying.
One or more services can operate on the same resource type. One or more services can provide the model structure for an entity of this resource type. Using Model service you can retrieve the list of all the structure elements that are model structures for a given resource type.
Metamodel Service
Operation
The Operation service provides operations to retrieve metamodel information of an operation element in the interface definition language.
Privilege
Component
The Component service provides operations to retrieve privilege information of a component element. A component element is said to contain privilege information if any one of package elements in it contains privilege information.
Package
The Package service provides operations to retrieve privilege information of a package element. A package element is said to contain privilege information if there is a default privilege assigned to all service elements contained in the package element or if one of the operation elements contained in one of the service elements in this package element has privilege information.
Service
The Service service provides operations to retrieve privilege information of a service element. A service element is said to contain privilege information if one of the operation elements contained in this service element has privilege information.
Privilege Service
Operation
The Operation service provides operations to retrieve privilege information of an operation element. An operation element is said to contain privilege information if there are any privileges assigned to the operation element or if one of the parameter elements contained in it has privileges assigned in privilege definition file.
