MetadataMetamodelServiceInfo

The ServiceInfo structure contains the metamodel information of all the operation elements, structure elements and enumeration elements containted in a service element.


Properties

constants Required

Metamodel information of all the constant elements contained in the service element. The key in the map is the name of the constant element and the value in the map is the metamodel information for the contant element.


string
documentation Required

English language documentation for the service element. It can contain HTML markup and Javadoc tags. The first sentence of the service documentation is a complete sentence that identifies the service by name and summarizes the purpose of the service. The remaining part of the documentation provides a summary of how to use the operations defined in the service.


enumerations Required

Metamodel information of all the enumeration elements contained in the service element. The key in the map is the identifier of the enumeration element and the value in the map is the metamodel information for the enumeration element. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vapi.enumeration. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vapi.enumeration.


metadata Required

Generic metadata elements for the service element. The key in the map is the name of the metadata element and the value is the data associated with that metadata element. The MetadataIdentifier contains possible string values for keys in the map.


string
name Required

Dot separated name of the service 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.


operations Required

Metamodel information of all the operation elements contained in the service element. The key in the map is the identifier of the operation element and the value in the map is the metamodel information for the operation element. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vapi.operation.


structures Required

Metamodel information of all the structure elements contained in the service element. The key in the map is the identifier of the structure element and the value in the map is the metamodel information for the structure element. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vapi.structure. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vapi.structure.

JSON Example

{
    "constants": {
        "key": {
            "documentation": "string",
            "type": {
                "category": "enum"
            },
            "value": {
                "category": "enum"
            }
        }
    },
    "documentation": "string",
    "enumerations": {
        "key": {
            "documentation": "string",
            "metadata": {
                "key": {
                    "elements": {
                        "key": {
                            "type": "enum"
                        }
                    }
                }
            },
            "name": "string",
            "values": [
                {
                    "documentation": "string",
                    "metadata": {
                        "key": {
                            "elements": {
                                "key": {
                                    "type": "enum"
                                }
                            }
                        }
                    },
                    "value": "string"
                }
            ]
        }
    },
    "metadata": {
        "key": {
            "elements": {
                "key": {
                    "type": "enum"
                }
            }
        }
    },
    "name": "string",
    "operations": {
        "key": {
            "documentation": "string",
            "errors": [
                {
                    "documentation": "string",
                    "structure_id": "string"
                }
            ],
            "metadata": {
                "key": {
                    "elements": {
                        "key": {
                            "type": "enum"
                        }
                    }
                }
            },
            "name": "string",
            "output": {
                "documentation": "string",
                "metadata": {
                    "key": {
                        "elements": {
                            "key": {
                                "type": "enum"
                            }
                        }
                    }
                },
                "type": {
                    "category": "enum"
                }
            },
            "params": [
                {
                    "documentation": "string",
                    "metadata": {
                        "key": {
                            "elements": {
                                "key": {
                                    "type": "enum"
                                }
                            }
                        }
                    },
                    "name": "string",
                    "type": {
                        "category": "enum"
                    }
                }
            ]
        }
    },
    "structures": {
        "key": {
            "constants": {
                "key": {
                    "documentation": "string",
                    "type": {
                        "category": "enum"
                    },
                    "value": {
                        "category": "enum"
                    }
                }
            },
            "documentation": "string",
            "enumerations": {
                "key": {
                    "documentation": "string",
                    "metadata": {
                        "key": {
                            "elements": {
                                "key": {
                                    "type": "enum"
                                }
                            }
                        }
                    },
                    "name": "string",
                    "values": [
                        {
                            "documentation": "string",
                            "metadata": {
                                "key": {
                                    "elements": {
                                        "key": {
                                            "type": "enum"
                                        }
                                    }
                                }
                            },
                            "value": "string"
                        }
                    ]
                }
            },
            "fields": [
                {
                    "documentation": "string",
                    "metadata": {
                        "key": {
                            "elements": {
                                "key": {
                                    "type": "enum"
                                }
                            }
                        }
                    },
                    "name": "string",
                    "type": {
                        "category": "enum"
                    }
                }
            ],
            "metadata": {
                "key": {
                    "elements": {
                        "key": {
                            "type": "enum"
                        }
                    }
                }
            },
            "name": "string",
            "type": "enum"
        }
    }
}
Feedback

Was this page helpful?