-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathopenapi.yaml
89 lines (84 loc) · 1.96 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
openapi: 3.1.0
externalDocs:
url: example.com
info:
title: Azure APIM test case.
summary: Azure APIM test
version: 1.0.0
security: [] # violates rule/security-ignored-azure-apim, should not be defined
servers:
- url: https://foo.bar
- url: baz.qux
paths:
/trucks:
post:
operationId: create-trucks
summary: Create a truck
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Truck"
responses:
'201':
description: CREATED
content:
application/json:
schema:
$ref: "#/components/schemas/Truck"
get:
operationId: get-trucks
summary: List trucks
externalDocs:
url: example.com
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Truck"
responses:
'200':
description: OK
content:
application/json:
# invalid because not using ref for the whole schema.
schema:
type: array
items:
- $ref: "#/components/schemas/Truck"
/scooters:
post:
operationId: create-scooters
summary: Create a scooter
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
responses:
'200':
description: OK
content:
application/json:
type: object
properties:
name:
type: string
components:
schemas:
Truck:
type: object
properties:
weight:
type: number
length:
type: number
make:
type: string
model:
type: string
year:
type: number