OAS Document Structure OAS documents are represented as JSON objects and conform to [RFC7159]. [YAML], being a superset of JSON, can be used as well to represent an OAS document. An OAS document consists of a single , see [OpenAPI]. It is represented as a JSON object. How to construct each of its name/value pairs (“fields” in OpenAPI terminology) is described in the following sections. Example : Structure of an OAS document { "swagger":"2.0", "info": …, "schemes": …, "host": …, "basepath": …, "consumes": …, "produces": …, "tags": …, "paths": …, "definitions": …, "parameters": …, "responses": … } Field swagger The value of swagger is the string "2.0". Field info The of info is an , see [OpenAPI]. It contains the fields title and version, and it contains the keyword description. Example : Info Object note that description accepts Markdown format – "info":{ "title":"OData Service for namespace ODataDemo", "version":"0.1.0", "description":"This OData service is located at http://localhost/service-root/\n\n## References\n- } Field title The of title is the value of the unqualified annotation Core.Description of the main schema or the entity container of the OData service.
OAS Document Structure OAS documents are represented as JSON objects and conform to [RFC7159]. [YAML], being a superset of JSON, can be used as well to represent an OAS document. An OAS document consists of a single , see [OpenAPI]. It is represented as a JSON object. How to construct each of its name/value pairs (“fields” in OpenAPI terminology) is described in the following sections. Example : Structure of an OAS document { "swagger":"2.0", "info": …, "schemes": …, "host": …, "basepath": …, "consumes": …, "produces": …, "tags": …, "paths": …, "definitions": …, "parameters": …, "responses": … } Field swagger The value of swagger is the string "2.0". Field info The of info is an , see [OpenAPI]. It contains the fields title and version, and it contains the keyword description. Example : Info Object – note that description accepts Markdown format "info":{ "title":"OData Service for namespace ODataDemo", "version":"0.1.0", "description":"This OData service is located at http://localhost/service-root/\n\n## References\n- } Field title The of title is the value of the unqualified annotation Core.Description of the main schema or the entity container of the OData service.
odata-openapi-v1.0-wd01-2016-11-28-final.docx