updates OAS

ITISFoundation · Oct 31, 2022 · 24ba336 · 24ba336
1 parent 8d417c5
commit 24ba336
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/services/catalog/openapi.json b/services/catalog/openapi.json
@@ -2928,13 +2928,13 @@
       "ServicePortGet": {
         "title": "ServicePortGet",
         "required": [
-          "name",
+          "key",
           "kind"
         ],
         "type": "object",
         "properties": {
-          "name": {
-            "title": "Name",
+          "key": {
+            "title": "Key name",
             "pattern": "^[^_\\W0-9]\\w*$",
             "type": "string",
             "description": "port identifier name"
@@ -2953,11 +2953,12 @@
           },
           "content_schema": {
             "title": "Content Schema",
-            "type": "object"
+            "type": "object",
+            "description": "jsonschema for the port's value. SEE https://json-schema.org/understanding-json-schema/"
           }
         },
         "example": {
-          "name": "input_1",
+          "key": "input_1",
           "kind": "input",
           "content_schema": {
             "title": "Sleep interval",

diff --git a/services/catalog/src/simcore_service_catalog/models/schemas/services_ports.py b/services/catalog/src/simcore_service_catalog/models/schemas/services_ports.py
@@ -58,7 +58,10 @@ def _guess_media_type(io: Union[ServiceInput, ServiceOutput]) -> str:
 
 class ServicePortGet(BaseModel):
     key: str = Field(
-        ..., description="port identifier name", regex=PUBLIC_VARIABLE_NAME_RE
+        ...,
+        description="port identifier name",
+        regex=PUBLIC_VARIABLE_NAME_RE,
+        title="Key name",
     )
     kind: PortKindStr
     content_media_type: Optional[str] = None