MetadataMetamodelComponentInfo

The ComponentInfo structure contains metamodel metadata information about a component element.


Properties

string
documentation Required

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.


metadata Required

Generic metadata for the component 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 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.


packages Required

Metamodel metadata information of all the package elements contained in the component element. The key in the map is the identifier of the package element and the value in the map is the metamodel information of the package 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.package. 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.package.

JSON Example

{
    "documentation": "string",
    "metadata": {
        "key": {
            "elements": {
                "key": {
                    "type": "enum"
                }
            }
        }
    },
    "name": "string",
    "packages": {
        "key": {
            "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",
            "services": {
                "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"
                                }
                            ]
                        }
                    },
                    "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"
                        }
                    }
                }
            },
            "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?