From ad6010061480dad71f516df65b2472ea11dfdf6f Mon Sep 17 00:00:00 2001 From: Michael Hoennig Date: Sun, 5 May 2024 15:13:21 +0200 Subject: [PATCH] more detailed OpenAPI spec for HsHostingAssetProps --- .../hs-hosting/hs-hosting-asset-schemas.yaml | 84 +++++++++++++++++-- 1 file changed, 79 insertions(+), 5 deletions(-) diff --git a/src/main/resources/api-definition/hs-hosting/hs-hosting-asset-schemas.yaml b/src/main/resources/api-definition/hs-hosting/hs-hosting-asset-schemas.yaml index 9f33b45d..59696a23 100644 --- a/src/main/resources/api-definition/hs-hosting/hs-hosting-asset-schemas.yaml +++ b/src/main/resources/api-definition/hs-hosting/hs-hosting-asset-schemas.yaml @@ -80,11 +80,85 @@ components: # forces generating a java.lang.Object containing a Map, instead of class AssetConfiguration anyOf: - type: object + # single source of supported properties just via /api/hs/hosting/asset-types/{assetType} + # TODO.impl: later, we could generate the config types and their properties from the validation config additionalProperties: true - HsHostingAssetProps: - # FIXME: add proper schema spec - anyOf: - - type: object - additionalProperties: true + PropertyDescriptor: + type: object + properties: + "type": + type: string + enum: + - integer + - boolean + - enumeration + "propertyName": + type: string + pattern: "^[ a-zA-Z0-9_-]$" + "required": + type: boolean + required: + - type + - propertyName + - required + IntegerPropertyDescriptor: + allOf: + - $ref: '#/components/schemas/PropertyDescriptor' + - type: object + properties: + "type": + type: string + enum: + - integer + "unit": + type: string + "min": + type: integer + minimum: 0 + "max": + type: integer + minimum: 0 + "step": + type: integer + minimum: 1 + required: + - "type" + - "propertyName" + - "required" + + BooleanPropertyDescriptor: + allOf: + - $ref: '#/components/schemas/PropertyDescriptor' + - type: object + properties: + "type": + type: string + enum: + - boolean + "falseIf": + type: object + anyOf: + - type: object + additionalProperties: true + + EnumerationPropertyDescriptor: + allOf: + - $ref: '#/components/schemas/PropertyDescriptor' + - type: object + properties: + "type": + type: string + enum: + - enumeration + "values": + type: array + items: + type: string + + HsHostingAssetProps: + anyOf: + - $ref: '#/components/schemas/IntegerPropertyDescriptor' + - $ref: '#/components/schemas/BooleanPropertyDescriptor' + - $ref: '#/components/schemas/EnumerationPropertyDescriptor'