Merge branch '1.0.x' into PIN-5121_add-latest-changes-in-catalog-api

src/main/resources/interface-specification.yml

@@ -71,7 +71,7 @@ paths:
               type: string
               format: uuid
             default: []
-          explode: false  
+          explode: false
         - in: query
           name: states
           description: comma separated sequence of states
@@ -149,7 +149,7 @@ paths:
           content:
             application/problem+json:
               schema:
-                $ref: '#/components/schemas/Problem'        
+                $ref: '#/components/schemas/Problem'
         '409':
           description: Name Conflict
           content:
@@ -239,7 +239,7 @@ paths:
           content:
             application/problem+json:
               schema:
-                $ref: '#/components/schemas/Problem'        
+                $ref: '#/components/schemas/Problem'
     delete:
       security:
         - bearerAuth: []
@@ -308,7 +308,7 @@ paths:
             type: integer
             format: int32
             minimum: 1
-            maximum: 50    
+            maximum: 50
       responses:
         '200':
           description: E-Service consumers retrieved
@@ -510,7 +510,7 @@ paths:
           content:
             application/problem+json:
               schema:
-                $ref: '#/components/schemas/Problem'           
+                $ref: '#/components/schemas/Problem'
   /eservices/{eServiceId}/descriptors/{descriptorId}/publish:
     parameters:
       - $ref: '#/components/parameters/CorrelationIdHeader'
@@ -854,13 +854,13 @@ paths:
           content:
             application/problem+json:
               schema:
-                $ref: '#/components/schemas/Problem'  
+                $ref: '#/components/schemas/Problem'
         '403':
           description: Forbidden
           content:
             application/problem+json:
               schema:
-                $ref: '#/components/schemas/Problem'  
+                $ref: '#/components/schemas/Problem'
         '404':
           description: E-Service descriptor document not found
           content:
@@ -958,7 +958,7 @@ paths:
           content:
             application/problem+json:
               schema:
-                $ref: '#/components/schemas/Problem'    
+                $ref: '#/components/schemas/Problem'
         '404':
           description: EService not found
           content:
@@ -995,7 +995,7 @@ paths:
           required: true
           schema:
             type: string
-            format: uuid    
+            format: uuid
       requestBody:
         description: A payload containing the risk analysis to update
         required: true
@@ -1011,7 +1011,7 @@ paths:
           content:
             application/problem+json:
               schema:
-                $ref: '#/components/schemas/Problem'  
+                $ref: '#/components/schemas/Problem'
         '404':
           description: EService not found
           content:
@@ -1045,7 +1045,7 @@ paths:
           required: true
           schema:
             type: string
-            format: uuid    
+            format: uuid
       responses:
         '204':
           description: EService Risk Analysis deleted.
@@ -1054,7 +1054,7 @@ paths:
           content:
             application/problem+json:
               schema:
-                $ref: '#/components/schemas/Problem'                          
+                $ref: '#/components/schemas/Problem'
         '404':
           description: EService not found
           content:
@@ -1066,7 +1066,57 @@ paths:
           content:
             application/problem+json:
               schema:
-                $ref: '#/components/schemas/Problem'                          
+                $ref: '#/components/schemas/Problem'
+  /eservices/{eServiceId}/update:
+    parameters:
+      - $ref: "#/components/parameters/CorrelationIdHeader"
+    post:
+      security:
+        - bearerAuth: [ ]
+      tags:
+        - process
+      summary: Update an e-service description
+      operationId: updateEServiceDescription
+      parameters:
+        - name: eServiceId
+          in: path
+          description: the eservice id
+          required: true
+          schema:
+            type: string
+            format: uuid
+      requestBody:
+        description: A payload containing the new description
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/EServiceDescriptionSeed"
+      responses:
+        "200":
+          description: EService description updated
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/EService"
+        "403":
+          description: Forbidden
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/Problem"
+        "404":
+          description: EService not found
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/Problem"
+        "400":
+          description: Bad request
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/Problem"
   /status:
     get:
       security: []
@@ -1276,7 +1326,7 @@ components:
     CreateEServiceDescriptorDocumentSeed:
       required:
         - documentId
-        - kind 
+        - kind
         - prettyName
         - filePath
         - fileName
@@ -1287,23 +1337,23 @@ components:
       properties:
         documentId:
           type: string
-          format: uuid   
+          format: uuid
         kind:
           $ref: '#/components/schemas/EServiceDocumentKind'
         prettyName:
-          type: string   
+          type: string
         filePath:
           type: string
         fileName:
           type: string
         contentType:
           type: string
         checksum:
-          type: string  
+          type: string
         serverUrls:
           type: array
           items:
-            type: string           
+            type: string
     UpdateEServiceDescriptorDocumentSeed:
       required:
         - prettyName
@@ -1394,7 +1444,7 @@ components:
               maxLength: 250
       required:
         - version
-        - answers    
+        - answers
     EService:
       type: object
       required:
@@ -1428,13 +1478,13 @@ components:
           items:
             $ref: '#/components/schemas/EServiceRiskAnalysis'
         mode:
-           $ref: '#/components/schemas/EServiceMode'    
+           $ref: '#/components/schemas/EServiceMode'
     EServiceMode:
       type: string
       description: Risk Analysis Mode
       enum:
         - RECEIVE
-        - DELIVER 
+        - DELIVER
     EServiceRiskAnalysis:
       type: object
       required:
@@ -1449,7 +1499,7 @@ components:
         name:
           type: string
         riskAnalysisForm:
-          $ref: '#/components/schemas/EServiceRiskAnalysisForm'  
+          $ref: '#/components/schemas/EServiceRiskAnalysisForm'
         createdAt:
           type: string
           format: date-time
@@ -1477,7 +1527,7 @@ components:
     EServiceRiskAnalysisSingleAnswer:
       type: object
       required:
-        - id 
+        - id
         - key
       properties:
         id:
@@ -1502,7 +1552,7 @@ components:
         values:
           type: array
           items:
-            type: string            
+            type: string
     EServiceConsumers:
       type: object
       properties:
@@ -1572,6 +1622,15 @@ components:
           type: string
         checksum:
           type: string
+    EServiceDescriptionSeed:
+      type: object
+      properties:
+        description:
+          type: string
+          minLength: 10
+          maxLength: 250
+      required:
+        - description
     EServiceDescriptor:
       type: object
       required:
@@ -1695,7 +1754,7 @@ components:
       description: EService Document Kind
       enum:
         - INTERFACE
-        - DOCUMENT    
+        - DOCUMENT
     AgreementState:
       type: string
       description: Agreement State