Skip to content

Commit f713340

Browse files
authored
Merge pull request #609 from geoadmin/feat-HDG-17-openapi-doc
HDG-17: Improve openapi spec update asset
2 parents dea1a92 + 942f107 commit f713340

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

spec/static/spec/v1/openapitransactional.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3623,7 +3623,7 @@ paths:
36233623
put:
36243624
summary: Update or create a collection asset
36253625
description: >-
3626-
Update or create a collection asset with Id `assetId` with a complete asset definition. If the asset doesn't exist it is then created.
3626+
Update or create a collection asset with Id `assetId` with a complete asset definition. If the asset doesn't exist it is then created. When updating an existing asset, optional fields can be deleted by setting them to `null`.
36273627
36283628
36293629
*Note: to upload an asset file see [Collection Asset Upload Management](#tag/Collection-Asset-Upload-Management)*
@@ -3955,7 +3955,7 @@ paths:
39553955
put:
39563956
summary: Update or create an asset
39573957
description: >-
3958-
Update or create an asset with Id `assetId` with a complete asset definition. If the asset doesn't exist it is then created.
3958+
Update or create an asset with Id `assetId` with a complete asset definition. If the asset doesn't exist it is then created. When updating an existing asset, optional fields can be deleted by setting them to `null`.
39593959
39603960
39613961
*Note: to upload an asset file see [Asset Upload Management](#tag/Asset-Upload-Management)*

spec/transaction/paths.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,8 @@ paths:
112112
summary: Update or create a collection asset
113113
description: >-
114114
Update or create a collection asset with Id `assetId` with a complete asset definition.
115-
If the asset doesn't exist it is then created.
115+
If the asset doesn't exist it is then created. When updating an existing asset,
116+
optional fields can be deleted by setting them to `null`.
116117
117118
118119
*Note: to upload an asset file see [Collection Asset Upload Management](#tag/Collection-Asset-Upload-Management)*
@@ -460,7 +461,8 @@ paths:
460461
summary: Update or create an asset
461462
description: >-
462463
Update or create an asset with Id `assetId` with a complete asset definition.
463-
If the asset doesn't exist it is then created.
464+
If the asset doesn't exist it is then created. When updating an existing asset,
465+
optional fields can be deleted by setting them to `null`.
464466
465467
466468
*Note: to upload an asset file see [Asset Upload Management](#tag/Asset-Upload-Management)*

0 commit comments

Comments
 (0)