[IOPLT-683] Add endpoint to exposed OpenAPI (#180)

pagopa · Sep 3, 2024 · 2d98cb9 · 2d98cb9
1 parent cebee25
commit 2d98cb9
Showing 1 changed file with 58 additions and 0 deletions.
diff --git a/infra/resources/modules/commons/api/ts_management/v1/_openapi.yaml b/infra/resources/modules/commons/api/ts_management/v1/_openapi.yaml
@@ -36,6 +36,42 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ProblemJson'
+    put:
+      operationId: updateSubscription
+      summary: Update a subscription
+      description: >-
+        Update the state of a subscription
+      parameters:
+        - $ref: '#/components/parameters/pathTrialId'
+        - $ref: '#/components/parameters/pathUserId'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateSubscription'
+      responses:
+        '202':
+          description: Accepted
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpdatedSubscription'
+        '400':
+          description: Bad Request.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+        '401':
+          description: Unauthorized
+        '404':
+          description: Not Found
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
   /trials/{trialId}/subscriptions:
     post:
       operationId: createSubscription
@@ -287,6 +323,28 @@ components:
           $ref: '#/components/schemas/UserId'
         state:
           $ref: '#/components/schemas/CreateSubscriptionState'
+    UpdateSubscription:
+      description: >
+        Payload to update the state of the subscription.
+      type: object
+      required:
+        - state
+      properties:
+        state:
+          $ref: '#/components/schemas/SubscriptionState'
+    UpdatedSubscription:
+      type: object
+      required:
+        - trialId
+        - userId
+        - state
+      properties:
+        trialId:
+          $ref: '#/components/schemas/TrialId'
+        userId:
+          $ref: '#/components/schemas/UserId'
+        state:
+          $ref: '#/components/schemas/SubscriptionState'
     Subscription:
       type: object
       required: