vapi metadata metamodel: component data
component_data structure contains the metamodel metadata information of a component element along with its fingerprint.Representation:
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| -.info | component_info | Metamodel information of the component element. This includes information about all the package elements contained in this component element. The metamodel information about a component could be quite large if there are a lot of package elements contained in this component.
|
| -.info.name | string | Dot separated name of the component element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.
|
| -.info.packages | object | Metamodel metadata information of all the package elements contained in the component element. The key in the key/value pairs is the identifier of the package element and the value in the key/value pairs is the metamodel information of the package element. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
| -.info.packages.* | package_info | |
| -.info.packages.*.name | string | Dot separated name of the package element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.
|
| -.info.packages.*.structures | object | Metamodel information of all the structure elements contained in the package element. The key in the key/value pairs is the identifier of the structure element and the value in the key/value pairs is the metamodel information for the structure element. This does not include the structure elements contained in the service elements that are contained in this package element. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
| -.info.packages.*.structures.* | structure_info | |
| -.info.packages.*.structures.*.name | string | Dot separated name of the structure element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.
|
| -.info.packages.*.structures.*.type | string | Type of the structure. Defines the kind of this structure element. In the interface definition language, structure element and error element have similar characteristics. The difference is that only error elements can be used to describe the errors of an operation element. Value is one of: |
| -.info.packages.*.structures.*.enumerations | object | Metamodel information of all the enumeration elements contained in the structure element. The key in the key/value pairs is the identifier of the enumeration element and the value is the metamodel information of the enumeration element. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
| -.info.packages.*.structures.*.enumerations.* | enumeration_info | |
| -.info.packages.*.structures.*.enumerations.*.name | string | Dot separated name of the enumeration element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.
|
| -.info.packages.*.structures.*.enumerations.*.values | enumeration_value_info[] | Metamodel information of all the enumeration value elements contained in this enumeration element. The order of the enumeration value elements in the list is same as the order in which they are defined in the interface definition file.
|
| -.info.packages.*.structures.*.enumerations.*.values[].value | string | Value in the enumerated type. All the characters in the string are capitalized.
|
| -.info.packages.*.structures.*.enumerations.*.values[].metadata | object | Additional metadata for enumeration value in the enumerated type. The key in the key/value pairs is the name of the metadata element and the value is the data associated with that metadata element. The vapi.metadata.metamodel.metadata_identifier contains possible string values for keys in the key/value pairs. Object with element values of type element_map. |
| -.info.packages.*.structures.*.enumerations.*.values[].metadata.* | element_map | |
| -.info.packages.*.structures.*.enumerations.*.values[].metadata.*.elements | object | Metamodel information of the metadata elements. The key parameter of the key/value pairs is the identifier for the element and the value corresponds to the element value. Object with element values of type element_value. |
| -.info.packages.*.structures.*.enumerations.*.values[].metadata.*.elements.* | element_value | |
| -.info.packages.*.structures.*.enumerations.*.values[].metadata.*.elements.*.type | string | Type of the value. Defines the valid types for values in metadata elements. Value is one of: |
| -.info.metadata | object | Generic metadata for the component element. The key in the key/value pairs is the name of the metadata element and the value is the data associated with that metadata element. The vapi.metadata.metamodel.metadata_identifier contains possible string values for keys in the key/value pairs. Object with element values of type element_map. |
| -.info.documentation | string | English language documentation for a component. It can contain HTML markup and documentation tags (similar to Javadoc tags). The first sentence of the package documentation is a complete sentence that identifies the component by name and summarizes the purpose of the component.
|
| -.fingerprint | string | Fingerprint of the metamodel metadata of the component component. Metamodel information could change when there is an infrastructure update and new functionality is added to an existing component. Since the data present in vapi.metadata.metamodel.component_data.info could be quite large, You should store the fingerprint associated with a component. After an update, by invoking the fingerprint operation, you can retrieve the new fingerprint for the component. If the new fingerprint and the previously stored fingerprint do not match, clients can use the get to retrieve the new metamodel information for the component.
|
| Optional | ||
| -.info.packages.*.structures.*.enumerations.*.values[].metadata.*.elements.*.long_value | long | Long value of the metadata element. Optional. It is only relevant when type has value LONG. This field is optional and it is only relevant when the value of |
| -.info.packages.*.structures.*.enumerations.*.values[].metadata.*.elements.*.string_value | string | String value of the metadata element. Optional. It is only relevant when type has value STRING. This field is optional and it is only relevant when the value of |
| -.info.packages.*.structures.*.enumerations.*.values[].metadata.*.elements.*.list_value | string[] | List of strings value of the metadata element. Optional. It is only relevant when type has value STRING_LIST. This field is optional and it is only relevant when the value of |
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| info | component_info | Metamodel information of the component element. This includes information about all the package elements contained in this component element. The metamodel information about a component could be quite large if there are a lot of package elements contained in this component.
|
| info.name | string | Dot separated name of the component element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.
|
| info.packages | list | Metamodel metadata information of all the package elements contained in the component element. The key in the key/value pairs is the identifier of the package element and the value in the key/value pairs is the metamodel information of the package element. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
| info.packages[].key | string | |
| info.packages[].value | package_info | |
| info.packages[].value.name | string | Dot separated name of the package element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.
|
| info.packages[].value.structures | list | Metamodel information of all the structure elements contained in the package element. The key in the key/value pairs is the identifier of the structure element and the value in the key/value pairs is the metamodel information for the structure element. This does not include the structure elements contained in the service elements that are contained in this package element. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
| info.packages[].value.structures[].key | string | |
| info.packages[].value.structures[].value | structure_info | |
| info.packages[].value.structures[].value.name | string | Dot separated name of the structure element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.
|
| info.packages[].value.structures[].value.type | string | Type of the structure. Defines the kind of this structure element. In the interface definition language, structure element and error element have similar characteristics. The difference is that only error elements can be used to describe the errors of an operation element. Value is one of: |
| info.packages[].value.structures[].value.enumerations | list | Metamodel information of all the enumeration elements contained in the structure element. The key in the key/value pairs is the identifier of the enumeration element and the value is the metamodel information of the enumeration element. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
| info.packages[].value.structures[].value.enumerations[].key | string | |
| info.packages[].value.structures[].value.enumerations[].value | enumeration_info | |
| info.packages[].value.structures[].value.enumerations[].value.name | string | Dot separated name of the enumeration element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.
|
| info.packages[].value.structures[].value.enumerations[].value.values | enumeration_value_info[] | Metamodel information of all the enumeration value elements contained in this enumeration element. The order of the enumeration value elements in the list is same as the order in which they are defined in the interface definition file.
|
| info.packages[].value.structures[].value.enumerations[].value.values[].value | string | Value in the enumerated type. All the characters in the string are capitalized.
|
| info.packages[].value.structures[].value.enumerations[].value.values[].metadata | list | Additional metadata for enumeration value in the enumerated type. The key in the key/value pairs is the name of the metadata element and the value is the data associated with that metadata element. The vapi.metadata.metamodel.metadata_identifier contains possible string values for keys in the key/value pairs. List of {"key": string, "value": element_map} |
| info.packages[].value.structures[].value.enumerations[].value.values[].metadata[].key | string | |
| info.packages[].value.structures[].value.enumerations[].value.values[].metadata[].value | element_map | |
| info.packages[].value.structures[].value.enumerations[].value.values[].metadata[].value.elements | list | Metamodel information of the metadata elements. The key parameter of the key/value pairs is the identifier for the element and the value corresponds to the element value. List of {"key": string, "value": element_value} |
| info.packages[].value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].key | string | |
| info.packages[].value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].value | element_value | |
| info.packages[].value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].value.type | string | Type of the value. Defines the valid types for values in metadata elements. Value is one of: |
| info.metadata | list | Generic metadata for the component element. The key in the key/value pairs is the name of the metadata element and the value is the data associated with that metadata element. The vapi.metadata.metamodel.metadata_identifier contains possible string values for keys in the key/value pairs. List of {"key": string, "value": element_map} |
| info.documentation | string | English language documentation for a component. It can contain HTML markup and documentation tags (similar to Javadoc tags). The first sentence of the package documentation is a complete sentence that identifies the component by name and summarizes the purpose of the component.
|
| fingerprint | string | Fingerprint of the metamodel metadata of the component component. Metamodel information could change when there is an infrastructure update and new functionality is added to an existing component. Since the data present in vapi.metadata.metamodel.component_data.info could be quite large, You should store the fingerprint associated with a component. After an update, by invoking the fingerprint operation, you can retrieve the new fingerprint for the component. If the new fingerprint and the previously stored fingerprint do not match, clients can use the get to retrieve the new metamodel information for the component.
|
| Optional | ||
| info.packages[].value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].value.long_value | long | Long value of the metadata element. Optional. It is only relevant when type has value LONG. This field is optional and it is only relevant when the value of |
| info.packages[].value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].value.string_value | string | String value of the metadata element. Optional. It is only relevant when type has value STRING. This field is optional and it is only relevant when the value of |
| info.packages[].value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].value.list_value | string[] | List of strings value of the metadata element. Optional. It is only relevant when type has value STRING_LIST. This field is optional and it is only relevant when the value of |