Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.78 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.78 KB

VMware Cloud Director Rest OpenAPI definitions

This is a repository of OpenAPI definitions for vCloud's Rest API. They are automatically generated from the public documentation to reduce human error, reduce human effort and to make it easy to stay up-to date.

vCloud Director has an official OpenAPI, but it contains little of the functionality of the Rest API.

API definition for VMware Cloud Director 10.1

Other versions can be found at the top level directory of this repository.

Problem Description

VMware Cloud Director Rest API supports responses and requests as both JSON and XML. But only XML is officially documented by VMWare. JSON is better suited for OpenAPI and modern usage. The mapping from XML to JSON is predictable.

Types are documented by VMware in XSD (XML Schema Definition). XSD is a complicated format. It supports lots of concepts and it has multiple ways of expressing a single concept. There are edge cases where I've not yet incorporated an XSD concept.

If you find an issue, tell me about it using Github and I shall try and address it.

License

The transformer (code that does the converting of the published documentation to OpenAPI) is MIT Licensed.

I've assigned the copyright of the OpenAPI definitions to VMware as it's a derivative of their documentation (but does copyright apply to APIs?)