diff options
| author |   MichaelMorris <michael.morris@est.tech> | 2023-06-28 15:01:34 +0100 |
|---|---|---|
| committer | MichaelMorris <michael.morris@est.tech> | 2023-06-28 15:01:38 +0100 |
| commit | ec12bc7580b1e46d09d44fda27b83d596d51586c (patch) | |
| tree | 80369dccaa3252c06c253f2cc2b9d5e22f971120 /docs/openapi/openapi-sdce-7.yaml | |
| parent | def9cf3577c1a8624ecb1e3fc8deb78b9717a4e7 (diff) | |
Update openapi files
Signed-off-by: MichaelMorris <michael.morris@est.tech>
Issue-ID: SDC-4557
Change-Id: I3ca60e6c285d1e5f78ced161128ed073f152d7e1
Diffstat (limited to 'docs/openapi/openapi-sdce-7.yaml')
| -rw-r--r-- | docs/openapi/openapi-sdce-7.yaml | 81 |
1 files changed, 77 insertions, 4 deletions
diff --git a/docs/openapi/openapi-sdce-7.yaml b/docs/openapi/openapi-sdce-7.yaml index 93681a29ca..5aa17ea1a7 100644 --- a/docs/openapi/openapi-sdce-7.yaml +++ b/docs/openapi/openapi-sdce-7.yaml @@ -534,26 +534,73 @@ paths: enum: - resources - services - - description: The filter key (resourceType only for resources) + - description: The category to filter the result set on in: query name: category schema: type: string - - description: The filter key (resourceType only for resources) + - description: The sub category to filter the result set on. Only applicable + when assetType = resources in: query name: subCategory schema: type: string - - description: The filter key (resourceType only for resources) + - description: The distribution status to filter the result set on in: query name: distributionStatus schema: type: string - - description: The filter key (resourceType only for resources) + - description: The resource type to filter the result set on. Only applicable + when assetType = resources in: query name: resourceType schema: type: string + - description: "Additional metadata keys to include in the response, not all\ + \ keys are supported.\nSupported keys: lastUpdateDate, creationDate, description,\ + \ uniqueId and category specific metadata keys" + in: query + name: include + schema: + type: array + items: + type: string + - description: "The version(s) to filter the result set on\nSyntax: /services?version=(highestMatchingVersionOnly|lessThan|greaterThan|equals)(:=)(value)" + examples: + An example request to get all services with version equal 2.0: + description: An example request to get all services with version equal + 2.0 + value: equals:2.0 + An example request to get all services with version greater than 1.1: + description: An example request to get all services with version greater + than 1.1 + value: greaterThan:1.1 + An example request to get all services with version less than 2.1: + description: An example request to get all services with version less + than 2.1 + value: lessThan:2.1 + An example request to get each service with highest version: + description: An example request to get each service with highest version + value: highestMatchingVersionOnly:true + in: query + name: version + schema: + type: string + - description: "The keys of the metadata to include in the entries in the result\ + \ set. Only applicable when assetType = services\nOnly category specific\ + \ metadata keys are supported\nSyntax: /services?metadata=<KEY1>(:=)<VALUE1>&metadata=<KEY2>(:=)<VALUE2>\ + \ ..." + examples: + An example request to get all services matching following Category Specific Metadata condition 'ETSI Version=3.3.1': + description: An example request to get all services matching following + Category Specific Metadata condition 'ETSI Version=3.3.1' + value: ETSI Version:3.3.1 + in: query + name: metadata + schema: + type: array + items: + type: string responses: "200": content: @@ -3193,6 +3240,10 @@ components: type: string normalizedName: type: string + notApplicableMetadataKeys: + type: array + items: + type: string ownerId: type: string ownerIdIfEmpty: @@ -3549,6 +3600,8 @@ components: - GET_INPUT - GET_PROPERTY - GET_ATTRIBUTE + toscaSubPath: + type: string type: type: string uniqueId: @@ -3785,6 +3838,8 @@ components: - GET_INPUT - GET_PROPERTY - GET_ATTRIBUTE + toscaSubPath: + type: string type: type: string uniqueId: @@ -3854,6 +3909,8 @@ components: format: int64 name: type: string + normative: + type: boolean ownerId: type: string ownerIdIfEmpty: @@ -4362,6 +4419,8 @@ components: - GET_INPUT - GET_PROPERTY - GET_ATTRIBUTE + toscaSubPath: + type: string type: type: string uniqueId: @@ -5257,6 +5316,8 @@ components: - GET_INPUT - GET_PROPERTY - GET_ATTRIBUTE + toscaSubPath: + type: string type: type: string uniqueId: @@ -5287,6 +5348,8 @@ components: - LESS_THAN - PATTERN - SCHEMA + originalType: + type: string propertyName: type: string targetType: @@ -5304,7 +5367,9 @@ components: - GET_INPUT - GET_ATTRIBUTE - YAML + - CUSTOM - CONCAT + - SEVERAL PropertyFilterDataDefinition: type: object properties: @@ -5763,6 +5828,8 @@ components: type: array items: type: string + tenant: + type: string topologyTemplate: type: boolean toscaArtifacts: @@ -5921,6 +5988,7 @@ components: - GET_PROPERTY - GET_ATTRIBUTE - CONCAT + - CUSTOM - YAML - STRING value: @@ -5951,6 +6019,10 @@ components: type: string sourceUniqueId: type: string + toscaIndexList: + type: array + items: + type: object type: type: string enum: @@ -5958,5 +6030,6 @@ components: - GET_PROPERTY - GET_ATTRIBUTE - CONCAT + - CUSTOM - YAML - STRING |