Update openapi files
[sdc.git] / docs / openapi / openapi-sdce-7.json
index a24edd2..278c6da 100644 (file)
             "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" : {
           "normalizedName" : {
             "type" : "string"
           },
+          "notApplicableMetadataKeys" : {
+            "type" : "array",
+            "items" : {
+              "type" : "string"
+            }
+          },
           "ownerId" : {
             "type" : "string"
           },
             "type" : "string",
             "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
           },
+          "toscaSubPath" : {
+            "type" : "string"
+          },
           "type" : {
             "type" : "string"
           },
             "type" : "string",
             "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
           },
+          "toscaSubPath" : {
+            "type" : "string"
+          },
           "type" : {
             "type" : "string"
           },
           "name" : {
             "type" : "string"
           },
+          "normative" : {
+            "type" : "boolean"
+          },
           "ownerId" : {
             "type" : "string"
           },
             "type" : "string",
             "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
           },
+          "toscaSubPath" : {
+            "type" : "string"
+          },
           "type" : {
             "type" : "string"
           },
             "type" : "string",
             "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
           },
+          "toscaSubPath" : {
+            "type" : "string"
+          },
           "type" : {
             "type" : "string"
           },
             "type" : "string",
             "enum" : [ "EQUAL", "IN_RANGE", "GREATER_THAN", "GREATER_OR_EQUAL", "LESS_OR_EQUAL", "LENGTH", "MIN_LENGTH", "MAX_LENGTH", "VALID_VALUES", "LESS_THAN", "PATTERN", "SCHEMA" ]
           },
+          "originalType" : {
+            "type" : "string"
+          },
           "propertyName" : {
             "type" : "string"
           },
           },
           "valueType" : {
             "type" : "string",
-            "enum" : [ "STATIC", "GET_PROPERTY", "GET_INPUT", "GET_ATTRIBUTE", "YAML", "CONCAT" ]
+            "enum" : [ "STATIC", "GET_PROPERTY", "GET_INPUT", "GET_ATTRIBUTE", "YAML", "CUSTOM", "CONCAT", "SEVERAL" ]
           }
         }
       },
               "type" : "string"
             }
           },
+          "tenant" : {
+            "type" : "string"
+          },
           "topologyTemplate" : {
             "type" : "boolean"
           },
           },
           "type" : {
             "type" : "string",
-            "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "YAML", "STRING" ]
+            "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "CUSTOM", "YAML", "STRING" ]
           },
           "value" : {
             "type" : "string"
           "sourceUniqueId" : {
             "type" : "string"
           },
+          "toscaIndexList" : {
+            "type" : "array",
+            "items" : {
+              "type" : "object"
+            }
+          },
           "type" : {
             "type" : "string",
-            "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "YAML", "STRING" ]
+            "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "CUSTOM", "YAML", "STRING" ]
           }
         }
       }