File: test_examples.yml

package info (click to toggle)
python-drf-spectacular 0.28.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,748 kB
  • sloc: python: 14,174; javascript: 114; sh: 61; makefile: 30
file content (229 lines) | stat: -rw-r--r-- 5,859 bytes parent folder | download | duplicates (3)
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
openapi: 3.0.3
info:
  title: ''
  version: 0.0.0
paths:
  /schema/:
    get:
      operationId: schema_list
      parameters:
      - in: query
        name: artist
        schema:
          type: string
        description: Filter by artist
        examples:
          ArtistQueryExample1:
            value: prince
            summary: Artist Query Example 1
            description: description for artist query example 1
          ArtistQueryExample2:
            value: miles davis
            summary: Artist Query Example 2
            description: description for artist query example 2
      tags:
      - schema
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/C'
              examples:
                SerializerCExampleRO:
                  value:
                  - field: 111
                  summary: Serializer C Example RO
          description: ''
    post:
      operationId: schema_create
      tags:
      - schema
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/A'
            examples:
              CreateExampleWO:
                value:
                  field: 22
                summary: Create Example WO
              CreateExampleRW:
                value:
                  field: 33
                summary: Create Example RW
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/A'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/A'
        required: true
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B'
              examples:
                CreateExampleRO:
                  value:
                    field: 11
                  summary: Create Example RO
                CreateExampleRW:
                  value:
                    field: 33
                  summary: Create Example RW
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
        '403':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                CreateError403IntegerExample:
                  value:
                    field: error (int)
                  summary: Create Error 403 Integer Example
                CreateError403StringExample:
                  value:
                    field: error (str)
                  summary: Create Error 403 String Example
          description: ''
  /schema/{id}/:
    get:
      operationId: schema_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this simple model.
        required: true
        examples:
          ExampleID1:
            value: 1
            summary: Example ID 1
          ExampleID2:
            value: 2
            summary: Example ID 2
      tags:
      - schema
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B'
          description: ''
  /schema/override_extend_schema_action/:
    post:
      operationId: schema_override_extend_schema_action_create
      tags:
      - schema
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/A'
            examples:
              SerializerAExampleWO:
                value:
                  field: 2
                summary: Serializer A Example WO
              SerializerAExampleRW:
                value:
                  field: 3
                summary: Serializer A Example RW custom summary
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/A'
            examples:
              SerializerAExampleRWExternal:
                externalValue: https://example.com/example_a.txt
                summary: Serializer A Example RW External
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/A'
        required: true
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B'
          description: ''
  /schema/raw_action/:
    get:
      operationId: schema_raw_action_retrieve
      tags:
      - schema
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B'
          description: ''
components:
  schemas:
    A:
      type: object
      properties:
        field:
          type: integer
      required:
      - field
    B:
      type: object
      properties:
        field:
          type: integer
      required:
      - field
    C:
      type: object
      properties:
        field:
          type: integer
      required:
      - field
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid