docusaurus-openapi-docs/demo/examples/tests/paramDefaults.yaml at 336f8c21ce6188c831e8c4647206bde985aa7d64 · PaloAltoNetworks/docusaurus-openapi-docs · 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
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
openapi: 3.0.0
info:
  title: Parameter Defaults Demo API
  version: 1.0.0
  description: |
    Validates that `schema.default` values are pre-populated in the API explorer
    form for parameters in every location (header, query, path, cookie) and for
    the common scalar/enum/boolean schema types.

    Regression coverage for: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/1226

tags:
  - name: defaults
    description: Parameter default value tests

paths:
  /headers:
    get:
      tags:
        - defaults
      summary: Header parameter defaults
      description: |
        Each header below declares a `schema.default`. The right-hand request
        form should render those defaults pre-filled and the generated code
        snippets should include them.
      parameters:
        - name: X-Api-Version
          in: header
          description: Free-form string default.
          required: true
          schema:
            type: string
            default: "2025-01-01"
        - name: X-Region
          in: header
          description: Enum default — should appear pre-selected in the dropdown.
          schema:
            type: string
            enum:
              - us-east-1
              - us-west-2
              - eu-central-1
            default: us-west-2
        - name: X-Trace-Enabled
          in: header
          description: Boolean default — should appear pre-selected as "true".
          schema:
            type: boolean
            default: true
      responses:
        "200":
          description: OK

  /query:
    get:
      tags:
        - defaults
      summary: Query parameter defaults
      parameters:
        - name: limit
          in: query
          description: Integer default.
          schema:
            type: integer
            default: 25
        - name: sort
          in: query
          description: Enum default.
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
      responses:
        "200":
          description: OK

  /items/{itemId}:
    get:
      tags:
        - defaults
      summary: Path parameter default
      description: |
        Path defaults are unusual but legal — confirm the form pre-fills the
        value rather than leaving the URL placeholder unresolved.
      parameters:
        - name: itemId
          in: path
          required: true
          schema:
            type: string
            default: sample-item
      responses:
        "200":
          description: OK

  /session:
    get:
      tags:
        - defaults
      summary: Cookie parameter default
      parameters:
        - name: session_id
          in: cookie
          schema:
            type: string
            default: anonymous
      responses:
        "200":
          description: OK