diff options
| author | Stephen Finucane <stephen@that.guru> | 2020-04-15 23:37:17 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2020-04-18 11:57:28 +0100 |
| commit | b4d77239c20f788fe65d71953b2889ebfa105397 (patch) | |
| tree | 43ce336be18094189cad27c2227b2ca168ee9bb4 /docs | |
| parent | 167079a5335b36a60b6cf02e57e69c24216103f3 (diff) | |
| download | patchwork-b4d77239c20f788fe65d71953b2889ebfa105397.tar patchwork-b4d77239c20f788fe65d71953b2889ebfa105397.tar.gz | |
docs: Make embedded fields nullable by default
As discussed at [1], "subtypes can add restrictions, but they cannot
relax restrictions that are already in place." These fields need to be
marked nullable and then "subclassed" to set non-nullability if
required.
[1] https://github.com/OAI/OpenAPI-Specification/issues/1368
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/schemas/latest/patchwork.yaml | 2 | ||||
| -rw-r--r-- | docs/api/schemas/patchwork.j2 | 2 | ||||
| -rw-r--r-- | docs/api/schemas/v1.0/patchwork.yaml | 2 | ||||
| -rw-r--r-- | docs/api/schemas/v1.1/patchwork.yaml | 2 | ||||
| -rw-r--r-- | docs/api/schemas/v1.2/patchwork.yaml | 2 |
5 files changed, 10 insertions, 0 deletions
diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml index cc0d97e..c4928a7 100644 --- a/docs/api/schemas/latest/patchwork.yaml +++ b/docs/api/schemas/latest/patchwork.yaml @@ -1420,6 +1420,7 @@ components: type: object title: Owner readOnly: true + nullable: false allOf: - $ref: '#/components/schemas/UserEmbedded' patches: @@ -2522,6 +2523,7 @@ components: readOnly: true UserEmbedded: type: object + nullable: true properties: id: title: ID diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2 index f5618d4..5491008 100644 --- a/docs/api/schemas/patchwork.j2 +++ b/docs/api/schemas/patchwork.j2 @@ -1469,6 +1469,7 @@ components: type: object title: Owner readOnly: true + nullable: false allOf: - $ref: '#/components/schemas/UserEmbedded' patches: @@ -2622,6 +2623,7 @@ components: readOnly: true UserEmbedded: type: object + nullable: true properties: id: title: ID diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml index 6c7c068..5622e87 100644 --- a/docs/api/schemas/v1.0/patchwork.yaml +++ b/docs/api/schemas/v1.0/patchwork.yaml @@ -1248,6 +1248,7 @@ components: type: object title: Owner readOnly: true + nullable: false allOf: - $ref: '#/components/schemas/UserEmbedded' patches: @@ -2147,6 +2148,7 @@ components: readOnly: true UserEmbedded: type: object + nullable: true properties: id: title: ID diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml index 6b497ab..43034fa 100644 --- a/docs/api/schemas/v1.1/patchwork.yaml +++ b/docs/api/schemas/v1.1/patchwork.yaml @@ -1253,6 +1253,7 @@ components: type: object title: Owner readOnly: true + nullable: false allOf: - $ref: '#/components/schemas/UserEmbedded' patches: @@ -2231,6 +2232,7 @@ components: readOnly: true UserEmbedded: type: object + nullable: true properties: id: title: ID diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml index 7bdbe66..3b441db 100644 --- a/docs/api/schemas/v1.2/patchwork.yaml +++ b/docs/api/schemas/v1.2/patchwork.yaml @@ -1420,6 +1420,7 @@ components: type: object title: Owner readOnly: true + nullable: false allOf: - $ref: '#/components/schemas/UserEmbedded' patches: @@ -2522,6 +2523,7 @@ components: readOnly: true UserEmbedded: type: object + nullable: true properties: id: title: ID |