File: read_only_write_only_ref_with_desc.yaml

package info (click to toggle)
python-datamodel-code-generator 0.45.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,052 kB
  • sloc: python: 29,621; makefile: 15
file content (39 lines) | stat: -rw-r--r-- 1,011 bytes parent folder | download
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: Read Only Write Only Ref with Description Test API
  version: "1.0"
paths: {}
components:
  schemas:
    Address:
      type: object
      properties:
        street:
          type: string
        city:
          type: string
          readOnly: true
    Base:
      type: object
      properties:
        base_id:
          type: integer
    # User with allOf and properties containing $ref + description
    # This triggers _parse_object_common_part with obj.properties
    User:
      type: object
      allOf:
        - $ref: "#/components/schemas/Base"
      required:
        - name
      properties:
        name:
          type: string
        # Property with $ref AND description - makes it a JsonSchemaObject with ref
        home_address:
          $ref: "#/components/schemas/Address"
          description: "User's home address"
        # Property with $ref AND readOnly
        work_address:
          $ref: "#/components/schemas/Address"
          readOnly: true