Skip to content

Commit 36f0674

Browse files
CharStringCharString
committed
📝 [#236] docs: Update OAS and TS OAS types
1 parent 14cc82e commit 36f0674

File tree

2 files changed

+70
-95
lines changed

2 files changed

+70
-95
lines changed

‎backend/openbeheer-oas.yaml‎

Lines changed: 39 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1142,7 +1142,7 @@ paths:
11421142
/api/v1/service/{slug}/zaaktypen/{zaaktype}/eigenschappen/{uuid}/:
11431143
get:
11441144
operationId: service_eigenschappen_retrieve_one
1145-
description: Retrieve an eigenschappe from Open Zaak.
1145+
description: Retrieve an eigenschap from Open Zaak.
11461146
summary: Get an eigenschappe
11471147
parameters:
11481148
- in: path
@@ -1181,7 +1181,7 @@ paths:
11811181
description: ''
11821182
put:
11831183
operationId: service_zaaktypen_eigenschappen_update
1184-
description: Fully update a eigenschappe from Open Zaak.
1184+
description: Fully update a eigenschap from Open Zaak.
11851185
summary: Put an eigenschappe
11861186
parameters:
11871187
- in: path
@@ -1232,7 +1232,7 @@ paths:
12321232
description: ''
12331233
patch:
12341234
operationId: service_zaaktypen_eigenschappen_partial_update
1235-
description: Partially update a eigenschappe from Open Zaak.
1235+
description: Partially update a eigenschap from Open Zaak.
12361236
summary: Patch an eigenschappe
12371237
parameters:
12381238
- in: path
@@ -1282,7 +1282,7 @@ paths:
12821282
description: ''
12831283
delete:
12841284
operationId: service_zaaktypen_eigenschappen_destroy
1285-
description: Remove permanently a eigenschappe from Open Zaak.
1285+
description: Remove permanently a eigenschap from Open Zaak.
12861286
summary: Delete an eigenschappe
12871287
parameters:
12881288
- in: path
@@ -3931,13 +3931,10 @@ components:
39313931
maxLength: 1000
39323932
minLength: 1
39333933
toelichting:
3934-
anyOf:
3935-
- description: Een toelichting op deze EIGENSCHAP en het belang hiervan
3936-
voor zaken van dit ZAAKTYPE.
3937-
type: string
3938-
maxLength: 1000
3939-
- type: 'null'
3940-
default: null
3934+
description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor
3935+
zaken van dit ZAAKTYPE.
3936+
type: string
3937+
maxLength: 1000
39413938
statustype:
39423939
anyOf:
39433940
- description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat
@@ -3946,21 +3943,18 @@ components:
39463943
maxLength: 1000
39473944
minLength: 1
39483945
- type: 'null'
3949-
default: null
39503946
beginGeldigheid:
39513947
anyOf:
39523948
- description: De datum waarop het is ontstaan.
39533949
type: string
39543950
format: date
39553951
- type: 'null'
3956-
default: null
39573952
eindeGeldigheid:
39583953
anyOf:
39593954
- description: De datum waarop het is opgeheven.
39603955
type: string
39613956
format: date
39623957
- type: 'null'
3963-
default: null
39643958
required:
39653959
- naam
39663960
- definitie
@@ -4068,6 +4062,8 @@ components:
40684062
uuid:
40694063
type: string
40704064
format: uuid
4065+
formaat:
4066+
$ref: '#/components/schemas/FormaatEnum'
40714067
naam:
40724068
description: De naam van de EIGENSCHAP
40734069
type: string
@@ -6363,66 +6359,42 @@ components:
63636359
type: object
63646360
properties:
63656361
naam:
6366-
anyOf:
6367-
- description: De naam van de EIGENSCHAP
6368-
type: string
6369-
maxLength: 20
6370-
minLength: 1
6371-
- type: 'null'
6372-
default: null
6362+
description: De naam van de EIGENSCHAP
6363+
type: string
6364+
maxLength: 20
6365+
minLength: 1
63736366
definitie:
6374-
anyOf:
6375-
- description: De beschrijving van de betekenis van deze EIGENSCHAP
6376-
type: string
6377-
maxLength: 255
6378-
minLength: 1
6379-
- type: 'null'
6380-
default: null
6367+
description: De beschrijving van de betekenis van deze EIGENSCHAP
6368+
type: string
6369+
maxLength: 255
6370+
minLength: 1
63816371
specificatie:
6382-
anyOf:
6383-
- type: 'null'
6384-
- $ref: '#/components/schemas/EigenschapSpecificatieRequest'
6385-
default: null
6372+
$ref: '#/components/schemas/EigenschapSpecificatieRequest'
63866373
toelichting:
6387-
anyOf:
6388-
- description: Een toelichting op deze EIGENSCHAP en het belang hiervan
6389-
voor zaken van dit ZAAKTYPE.
6390-
type: string
6391-
maxLength: 1000
6392-
- type: 'null'
6393-
default: null
6374+
description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor
6375+
zaken van dit ZAAKTYPE.
6376+
type: string
6377+
maxLength: 1000
63946378
zaaktype:
6395-
anyOf:
6396-
- description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze
6397-
EIGENSCHAP van belang is.
6398-
type: string
6399-
maxLength: 1000
6400-
minLength: 1
6401-
- type: 'null'
6402-
default: null
6379+
description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze
6380+
EIGENSCHAP van belang is.
6381+
type: string
6382+
maxLength: 1000
6383+
minLength: 1
64036384
statustype:
6404-
anyOf:
6405-
- description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat
6406-
een STATUS van het STATUSTYPE kan worden gezet.
6407-
type: string
6408-
maxLength: 1000
6409-
minLength: 1
6410-
- type: 'null'
6411-
default: null
6385+
description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat
6386+
een STATUS van het STATUSTYPE kan worden gezet.
6387+
type: string
6388+
maxLength: 1000
6389+
minLength: 1
64126390
beginGeldigheid:
6413-
anyOf:
6414-
- description: De datum waarop het is ontstaan.
6415-
type: string
6416-
format: date
6417-
- type: 'null'
6418-
default: null
6391+
description: De datum waarop het is ontstaan.
6392+
type: string
6393+
format: date
64196394
eindeGeldigheid:
6420-
anyOf:
6421-
- description: De datum waarop het is opgeheven.
6422-
type: string
6423-
format: date
6424-
- type: 'null'
6425-
default: null
6395+
description: De datum waarop het is opgeheven.
6396+
type: string
6397+
format: date
64266398
required: []
64276399
PatchedPatchedInformatieObjectTypeRequest:
64286400
title: PatchedInformatieObjectTypeRequest

‎frontend/src/types/api.d.ts‎

Lines changed: 31 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -336,25 +336,25 @@ export interface paths {
336336
};
337337
/**
338338
* Get an eigenschappe
339-
* @description Retrieve an eigenschappe from Open Zaak.
339+
* @description Retrieve an eigenschap from Open Zaak.
340340
*/
341341
get: operations["service_eigenschappen_retrieve_one"];
342342
/**
343343
* Put an eigenschappe
344-
* @description Fully update a eigenschappe from Open Zaak.
344+
* @description Fully update a eigenschap from Open Zaak.
345345
*/
346346
put: operations["service_zaaktypen_eigenschappen_update"];
347347
post?: never;
348348
/**
349349
* Delete an eigenschappe
350-
* @description Remove permanently a eigenschappe from Open Zaak.
350+
* @description Remove permanently a eigenschap from Open Zaak.
351351
*/
352352
delete: operations["service_zaaktypen_eigenschappen_destroy"];
353353
options?: never;
354354
head?: never;
355355
/**
356356
* Patch an eigenschappe
357-
* @description Partially update a eigenschappe from Open Zaak.
357+
* @description Partially update a eigenschap from Open Zaak.
358358
*/
359359
patch: operations["service_zaaktypen_eigenschappen_partial_update"];
360360
trace?: never;
@@ -1041,14 +1041,11 @@ export interface components {
10411041
specificatie: components["schemas"]["EigenschapSpecificatieRequest"];
10421042
/** @description URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze EIGENSCHAP van belang is. */
10431043
zaaktype: string;
1044-
/** @default null */
1045-
toelichting: string | null;
1046-
/** @default null */
1047-
statustype: string | null;
1048-
/** @default null */
1049-
beginGeldigheid: string | null;
1050-
/** @default null */
1051-
eindeGeldigheid: string | null;
1044+
/** @description Een toelichting op deze EIGENSCHAP en het belang hiervan voor zaken van dit ZAAKTYPE. */
1045+
toelichting?: string;
1046+
statustype?: string | null;
1047+
beginGeldigheid?: string | null;
1048+
eindeGeldigheid?: string | null;
10521049
};
10531050
/** EigenschapSpecificatie */
10541051
EigenschapSpecificatie: {
@@ -1094,6 +1091,7 @@ export interface components {
10941091
EigenschapWithUUID: {
10951092
/** Format: uuid */
10961093
uuid?: string;
1094+
formaat?: components["schemas"]["FormaatEnum"];
10971095
/** @description De naam van de EIGENSCHAP */
10981096
naam: string;
10991097
/** @description De beschrijving van de betekenis van deze EIGENSCHAP */
@@ -2008,22 +2006,27 @@ export interface components {
20082006
};
20092007
/** PatchedEigenschapRequest */
20102008
PatchedPatchedEigenschapRequest: {
2011-
/** @default null */
2012-
naam: string | null;
2013-
/** @default null */
2014-
definitie: string | null;
2015-
/** @default null */
2016-
specificatie: null | components["schemas"]["EigenschapSpecificatieRequest"];
2017-
/** @default null */
2018-
toelichting: string | null;
2019-
/** @default null */
2020-
zaaktype: string | null;
2021-
/** @default null */
2022-
statustype: string | null;
2023-
/** @default null */
2024-
beginGeldigheid: string | null;
2025-
/** @default null */
2026-
eindeGeldigheid: string | null;
2009+
/** @description De naam van de EIGENSCHAP */
2010+
naam?: string;
2011+
/** @description De beschrijving van de betekenis van deze EIGENSCHAP */
2012+
definitie?: string;
2013+
specificatie?: components["schemas"]["EigenschapSpecificatieRequest"];
2014+
/** @description Een toelichting op deze EIGENSCHAP en het belang hiervan voor zaken van dit ZAAKTYPE. */
2015+
toelichting?: string;
2016+
/** @description URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze EIGENSCHAP van belang is. */
2017+
zaaktype?: string;
2018+
/** @description Status type moet (onder andere) deze EIGENSCHAP hebben, voordat een STATUS van het STATUSTYPE kan worden gezet. */
2019+
statustype?: string;
2020+
/**
2021+
* Format: date
2022+
* @description De datum waarop het is ontstaan.
2023+
*/
2024+
beginGeldigheid?: string;
2025+
/**
2026+
* Format: date
2027+
* @description De datum waarop het is opgeheven.
2028+
*/
2029+
eindeGeldigheid?: string;
20272030
};
20282031
/** PatchedInformatieObjectTypeRequest */
20292032
PatchedPatchedInformatieObjectTypeRequest: {

0 commit comments

Comments
 (0)