1swagger: '2.0'
2info:
3 title: Responses
4 version: 0.1.0
5
6definitions:
7 Error:
8 type: object
9 description: |
10 Contains all the properties any error response from the API will contain.
11 Some properties are optional so might be empty most of the time
12 required:
13 - code
14 - message
15 properties:
16 code:
17 description: the error code, this is not necessarily the http status code
18 type: integer
19 format: int32
20 message:
21 description: a human readable version of the error
22 type: string
23 helpUrl:
24 description: an optional url for getting more help about this error
25 type: string
26 format: uri
27
28 myArray:
29 type: array
30 items:
31 $ref: '#/definitions/myItems'
32
33 myItems:
34 type: object
35 properties:
36 propItems1:
37 type: integer
38 propItems2:
39 $ref: 'remote/remote.yaml#/aRemotePlace'
40
41otherPlace:
42 Error:
43 type: object
44 properties:
45 message:
46 type: string
47
48parameters:
49 BadRequest:
50 name: badRequest
51 in: body
52 schema:
53 $ref: '#/definitions/Error'
54 GoodRequest:
55 name: goodRequest
56 in: body
57 schema:
58 $ref: '#/otherPlace/Error'
59 PlainRequest:
60 name: plainRequest
61 in: body
62 schema:
63 type: integer
64 StrangeRequest:
65 name: stangeRequest
66 in: body
67 schema:
68 $ref: 'responses.yaml#/otherPlace/Error'
69 RemoteRequest:
70 name: remoteRequest
71 in: body
72 schema:
73 $ref: './remote/remote.yaml#/moreRemoteThanYouCanThink'
74
75responses:
76 BadRequest:
77 description: Bad request
78 schema:
79 $ref: '#/definitions/Error'
80 GoodRequest:
81 description: good request
82 schema:
83 $ref: '#/otherPlace/Error'
84 PlainRequest:
85 description: plain request
86 schema:
87 type: integer
88 StrangeRequest:
89 description: strange request
90 schema:
91 $ref: 'responses.yaml#/otherPlace/Error'
92 RemoteRequest:
93 description: remote request
94 schema:
95 $ref: './remote/remote.yaml#/moreRemoteThanYouCanThink'
96
97paths:
98 /:
99 get:
100 summary: GET
101 operationId: getAll
102 responses:
103 200:
104 description: Ok
View as plain text