OpenAPI-Specification/tests/schema/pass/link-object-examples.yaml at e54843b6df285ba9f246f69a93005b585cda1093 · ralfhandl/OpenAPI-Specification · GitHub

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
openapi: 3.2.0
info:
  title: API
  version: 1.0.0
paths:
  /users/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: the user identifier, as userId
        schema:
          type: string
    get:
      responses:
        '200':
          description: the user being returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid: # the unique user id
                    type: string
                    format: uuid
          links:
            address:
              # the target link operationId
              operationId: getUserAddress
              parameters:
                # get the `id` field from the request path parameter named `id`
                userid: $request.path.id
            address2:
              operationId: getUserAddressByUUID
              parameters:
                # get the `uuid` field from the `uuid` field in the response body
                userUuid: $response.body#/uuid
            UserRepositories:
              # returns array of '#/components/schemas/repository'
              operationRef: '#/paths/~12.0~1repositories~1%7Busername%7D/get'
              parameters:
                username: $response.body#/username
            UserRepositories2:
              # returns array of '#/components/schemas/repository'
              operationRef: https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1%7Busername%7D/get
              parameters:
                username: $response.body#/username
  # the path item of the linked operation
  /users/{userid}/address:
    parameters:
      - name: userid
        in: path
        required: true
        description: the user identifier, as userId
        schema:
          type: string
    # linked operation
    get:
      operationId: getUserAddress
      responses:
        '200':
          description: the user's address