«OpenAPI 3 Specification»

Stereotype

OpenAPI3Specification

Applicable Elements

Component

Tagged Values

Name

Type

Description

 resourceName

String

Name of the file that will be generated as OpenAPI specification file. By default it will be named as openapi.yml.

openAPIVersion

String

OpenAPI version on which the specification is based. Default value is 3.0.0.

apiVersion

String

Version of the API that is represented by this OpenAPI specification. We strongly recommend to version you API according to the rules of Semantic Versioning.

contactName

String

Name of the team or person that will be mentioned in your OpenAPI specification as contact.

contactURL

String

URL of the contact for your OpenAPI specification.

contactEmail

String

Email of the contact that is mentioned in your OpenAPI specification.

licenseName

String

Name of the license under which your OpenAPI specification is published e.g. Apache 2.0.

licenseURL

String

URL under which the used license is available.