REST API - info

info

The info structure contains the metadata source information.

Representations:

JSON
XML

{
    "address": "http://myurl.com",
    "description": "string",
    "filepath": "string",
    "type": "FILE"
}

<?xml version="1.0" ?>
<ns0:Info xmlns:ns0="http://vmware.com/vapi/metadata/cli/source" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <filepath>string</filepath>
  <address>http://myurl.com</address>
  <description>string</description>
  <type>FILE</type>
</ns0:Info>

Attributes:

Name	Type	Required	Description
description *	string	Yes	English language human readable description of the source.
type *	com.vmware.vapi.metadata.source_type	Yes	The type (`FILE`, `REMOTE`) of the metadata source. The `source_type` enumerated type defines the types of sources for API metadata. You specify the type of source when adding a metadata source to a metadata service. Values one of FILE: Indicates the metadata source is a JSON file. REMOTE: Indicates the metadata source is a remote server.
filepath	string	No. This field is optional and it is only relevant when the value of `type` is SourceType#FILE.	Absolute file path of the CLI metadata file that has the CLI information about one component. The `filepath` is the path to the file in the server's filesystem. Required if type has value FILE.
address	URI	No. This field is optional and it is only relevant when the value of `type` is SourceType#REMOTE.	Connection information for the remote server. This should be in the format http(s)://IP:port/namespace. The remote server must contain the services in the com.vmware.vapi.metadata.cli package. It must expose CLI information of one or more components. Required if type has value REMOTE.

com.vmware.vapi.metadata.cli.source

info