openapi-diff/core/src/test/resources/schemaDiff/required-property-1.yaml at c051b7e5f8921edd77c269bc59e7d90b06ea1b7c · OpenAPITools/openapi-diff · 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
openapi: 3.0.0
info:
  title: Required Property Test API
  version: 1.0.0
paths:
  /schema/required:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [becomesOptional, unchanged]
              properties:
                becomesRequired:
                  type: string
                  description: Property that changes from optional to required (breaking for requests)
                becomesOptional:
                  type: string
                  description: Property that changes from required to optional (breaking for responses)
                unchanged:
                  type: string
                  description: Property that remains unchanged in terms of required status
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                type: object
                required: [becomesOptional, unchanged]
                properties:
                  becomesRequired:
                    type: string
                  becomesOptional:
                    type: string
                  unchanged:
                    type: string