1. Types
  2. vapi
  3. metadata

vapi metadata: source create spec

The source_create_spec structure contains the registration information for a metadata source.

Representation:

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

Attributes:

Name Type Description
Required
description string English language human readable description of the source.
type string Type of the metadata source.

Defines the types of sources for API metadata. You specify the type of source when adding a metadata source to a metadata service. Value is one of:
FILE: Indicates the metadata source is a JSON file.
REMOTE: Indicates the metadata source is a remote server.
Optional
filepath string Absolute file path of the metamodel metadata file that has the metamodel information about one component element.

Optional. It is only relevant when type has value FILE. This field is optional and it is only relevant when the value of type is FILE.
address URI Connection information of the remote server. This should be of the format http(s)://IP:port/namespace.

The remote server should contain the services in vapi.metadata.metamodel API. It could expose metamodel information of one or more components.

Optional. It is only relevant when type has value REMOTE. This field is optional and it is only relevant when the value of type is REMOTE.