File: callbacks.yml

package info (click to toggle)
golang-github-getkin-kin-openapi 0.124.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,288 kB
  • sloc: sh: 344; makefile: 4
file content (71 lines) | stat: -rw-r--r-- 1,729 bytes parent folder | download | duplicates (2)
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
openapi: 3.1.0
info:
  title: Callback refd
  version: 1.2.3
paths:
  /trans:
    post:
      description: ''
      requestBody:
        description: ''
        content:
          'application/json':
            schema:
              properties:
                id: {type: string}
                email: {format: email}
      responses:
        '201':
          description: subscription successfully created
          content:
            application/json:
              schema:
                type: object
      callbacks:
        transactionCallback:
          'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}':
            $ref: callback-transactioned.yml

  /other:
    post:
      description: ''
      parameters:
      - name: queryUrl
        in: query
        required: true
        description: |
          bla
          bla
          bla
        schema:
          type: string
          format: uri
          example: https://example.com
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      callbacks:
        myEvent:
          $ref: '#/components/callbacks/MyCallbackEvent'

components:
  schemas:
    SomePayload: {type: object}
    SomeOtherPayload: {type: boolean}
  callbacks:
    MyCallbackEvent:
      '{$request.query.queryUrl}':
        post:
          requestBody:
            description: Callback payload
            content:
              'application/json':
                schema:
                  $ref: '#/components/schemas/SomeOtherPayload'
          responses:
            '200':
              description: callback successfully processed