@@ -2,17 +2,42 @@ openapi: 3.1.0
22info :
33 version : 1.0.0
44 title : Example.com
5- termsOfService : ' https://example.com/terms/'
5+ termsOfService : https://example.com/terms/
66 contact :
778- url : ' http://example.com/contact'
8+ url : http://example.com/contact
99 license :
1010 name : Apache 2.0
11- url : ' http://www.apache.org/licenses/LICENSE-2.0.html'
11+ url : http://www.apache.org/licenses/LICENSE-2.0.html
1212 x-logo :
13- url : ' https://redocly.github.io/openapi-template/logo.png'
14- description :
15- $ref : ./info-description.md
13+ url : https://redocly.github.io/openapi-template/logo.png
14+ description : >
15+ This is an **example** API to demonstrate features of the OpenAPI
16+ specification.
17+
18+ # Introduction
19+
20+ This API definition is intended to to be a good starting point for
21+ describing your API in [OpenAPI/Swagger
22+ format](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md).
23+
24+ It also demonstrates features of the
25+ [create-openapi-repo](https://github.com/Redocly/create-openapi-repo) tool
26+ and the [Redoc](https://github.com/Redocly/Redoc) documentation engine. Beyond
27+ the standard OpenAPI syntax, we use a few
28+ [vendor extensions](https://github.com/Redocly/Redoc/blob/master/docs/redoc-vendor-extensions.md).
29+
30+ # OpenAPI Specification
31+
32+ The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which
33+ allows both humans and computers to discover and understand the capabilities
34+ of the service without access to source
35+ code, documentation, or through network traffic inspection. When properly
36+ defined via OpenAPI, a consumer can
37+ understand and interact with the remote service with a minimal amount of
38+ implementation logic. Similar to what
39+ interfaces have done for lower-level programming, OpenAPI removes the
40+ guesswork in calling the service.
1641tags :
1742 - name : Echo
1843 description : Example echo operations.
@@ -21,31 +46,31 @@ tags:
2146 - name : Tag
2247 description : This is a tag description.
2348servers :
24- - url : ' https://{tenant}/api/v1'
49+ - url : https://{tenant}/api/v1
2550 variables :
2651 tenant :
2752 default : www
2853 description : Your tenant id
29- - url : ' https://example.com/api/v1'
54+ - url : https://example.com/api/v1
3055paths :
31- ' /users/{username} ' :
32- $ref : ' paths/users_{username}.yaml'
56+ /users/{username} :
57+ $ref : paths/users_{username}.yaml
3358 /echo :
3459 $ref : paths/echo.yaml
3560 /pathItem :
36- $ref : paths/path-item .yaml
61+ $ref : paths/pathItem .yaml
3762 /pathItemWithExamples :
38- $ref : paths/path-item-with-examples .yaml
63+ $ref : paths/pathItemWithExamples .yaml
3964components :
4065 securitySchemes :
4166 main_auth :
4267 type : oauth2
4368 flows :
4469 implicit :
45- authorizationUrl : ' http://example.com/api/oauth/dialog'
70+ authorizationUrl : http://example.com/api/oauth/dialog
4671 scopes :
47- ' read:users ' : read users info
48- ' write:users ' : modify or remove users
72+ read:users : read users info
73+ write:users : modify or remove users
4974 api_key :
5075 type : apiKey
5176 in : header
0 commit comments