File: test_callbacks_split_request.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 (212 lines) | stat: -rw-r--r-- 5,240 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
openapi: 3.0.3
info:
  title: ''
  version: 0.0.0
paths:
  /x/:
    get:
      operationId: x_list
      tags:
      - x
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Simple'
          description: ''
  /x/{id}/:
    get:
      operationId: x_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this simple model.
        required: true
      tags:
      - x
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Simple'
          description: ''
  /x/health/:
    post:
      operationId: x_health_create
      tags:
      - x
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/HealthRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/HealthRequest'
        required: true
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          description: No response body
      callbacks:
        HealthEvent:
          '{$request.body#/callbackUrl}':
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/Event'
                required: true
              responses:
                '200':
                  description: status new ack
            delete:
              deprecated: true
              responses:
                '200':
                  description: status expiration
            put:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/Event'
                required: true
              responses:
                '200':
                  content:
                    application/json:
                      schema:
                        $ref: '#/components/schemas/EventRequest'
                  description: ''
            patch:
              requestBody:
                content:
                  application/yaml:
                    schema:
                      type: integer
              responses:
                '200':
                  description: Raw schema
  /x/subscription/:
    post:
      operationId: x_subscription_create
      tags:
      - x
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscribeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SubscribeRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SubscribeRequest'
        required: true
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          description: No response body
      callbacks:
        SubscriptionEvent:
          '{$request.body#/callbackUrl}':
            post:
              description: pushes events to callbackUrl as "application/x-www-form-urlencoded"
              summary: some summary
              requestBody:
                content:
                  application/x-www-form-urlencoded:
                    schema:
                      $ref: '#/components/schemas/Event'
                required: true
              responses:
                '200':
                  description: event was successfully received
                4XX:
                  description: event will be retried shortly
components:
  schemas:
    Event:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        change:
          type: string
      required:
      - change
      - id
    EventRequest:
      type: object
      properties:
        change:
          type: string
          minLength: 1
        external_id:
          type: string
          writeOnly: true
          minLength: 1
      required:
      - change
      - external_id
    HealthRequest:
      type: object
      properties:
        callbackUrl:
          type: string
          format: uri
          minLength: 1
      required:
      - callbackUrl
    Simple:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
      required:
      - id
    SubscribeRequest:
      type: object
      properties:
        callbackUrl:
          type: string
          format: uri
          minLength: 1
      required:
      - callbackUrl
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid