File tree 1 file changed +73
-0
lines changed
1 file changed +73
-0
lines changed Original file line number Diff line number Diff line change
1
+ openapi : 3.1.0
2
+ info :
3
+ title : Security Schemes example
4
+ version : 1.0.0
5
+ paths :
6
+ /pets :
7
+ get :
8
+ security :
9
+ # Either a `read/write` ClientCertificate ...
10
+ - ClientCertificate :
11
+ - read
12
+ - write
13
+ # ... or a `read/write` OAuth2
14
+ - OAuth2 :
15
+ - read
16
+ - write
17
+ summary : List all pets
18
+ operationId : listPets
19
+ parameters :
20
+ - name : limit
21
+ in : query
22
+ description : How many items to return at one time (max 100)
23
+ required : false
24
+ schema :
25
+ type : integer
26
+ format : int32
27
+ responses :
28
+ ' 200 ' :
29
+ description : A paged array of pets
30
+ content :
31
+ application/json :
32
+ schema :
33
+ $ref : " #/components/schemas/Pets"
34
+ components :
35
+ securitySchemes :
36
+ OAuth2 :
37
+ type : oauth2
38
+ flows :
39
+ authorizationCode :
40
+ authorizationUrl : https://example.com/oauth/authorize
41
+ tokenUrl : https://example.com/oauth/token
42
+ scopes :
43
+ read : Grants read access
44
+ write : Grants write access
45
+ admin : Grants access to admin operations
46
+ ClientCertificate :
47
+ type : mutualTLS
48
+ description : |-
49
+ To autenticate you must provide a trusted client certificate.
50
+ OAS does not mandate a trust model.
51
+
52
+ You can use scopes too, though this is might not be
53
+ supported in tooling:
54
+ - read: Grants read access
55
+ - write: Grants write access
56
+ - admin: Grants access to admin operations
57
+ schemas :
58
+ Pet :
59
+ required :
60
+ - id
61
+ - name
62
+ properties :
63
+ id :
64
+ type : integer
65
+ format : int64
66
+ name :
67
+ type : string
68
+ tag :
69
+ type : string
70
+ Pets :
71
+ type : array
72
+ items :
73
+ $ref : " #/components/schemas/Pet"
You can’t perform that action at this time.
0 commit comments