com.vmware.vapi.metadata.cli.source

The source service provides operations to manage the sources of command line interface (CLI) metadata information.

The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains CLI information.

A CLI metadata file contains information about one component element. When a CLI metadata file is added as a source, each source contributes only one component element's metadata.

CLI metadata can also be discovered from a remote server that supports the CLI metadata services (see com.vmware.vapi.metadata.cli) package. Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.

create

POST /com/vmware/vapi/metadata/cli/source/id:{source_id}
POST /com/vmware/vapi/metadata/cli/source/id:{source_id}?~action=create
POST /com/vmware/vapi/metadata/cli/source?~action=create

Creates a new metadata source. Once the server validates the registration information of the metadata source, the CLI metadata is retrieved from the source. This populates elements in all the services defined in com.vmware.vapi.metadata.cli package.
Request:
Representations:
{
    "source_id": "obj-103",
    "spec": {}
}
<?xml version="1.0" ?>
<ns0:Create-Input xmlns:ns0="http://vmware.com/vapi/metadata/cli/source" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <spec>
</spec>
  <source_id>obj-103</source_id>
</ns0:Create-Input>
POST /com/vmware/vapi/metadata/cli/source?~action=create
&spec~emptyStruct
&source_id=obj-103

Parameters:
Name Type Required Description
source_id
 *
 ID Yes metadata source identifier. Id of type com.vmware.vapi.metadata.source.
spec
 *
 create_spec Yes create specification.

Response:
Representations:

Parameters:
Name Type Required Description
result VOID Yes

Errors:
Type Description HTTP Status Code
already_exists If the metadata source identifier is already registered with the infrastructure. 400
invalid_argument If type of the source specified in CreateSpec#type is invalid. 400
not_found If the file specified in CreateSpec#filepath does not exist. 404

Copyright © 2014. All Rights Reserved.