[#IOPID-1838] Edited openapi spec (#76)

pagopa · May 28, 2024 · d5d04fc · d5d04fc
1 parent c24bf38
commit d5d04fc
Showing 1 changed file with 195 additions and 6 deletions.
diff --git a/openapi/external.yaml b/openapi/external.yaml
@@ -10,15 +10,16 @@ servers:
 paths:
   /validate-profile-email:
     get:
-      operationId: validateProfileEmail
-      description: Validate the email
+      operationId: validateTokenAndRedirect
+      description: |
+        DEPRECATED method. use v2 instead
+      deprecated: true
       parameters:
         - in: query
           name: token
           required: true
           schema:
-            type: string
-            minLength: 1
+            $ref: "#/components/schemas/ValidationToken"
         - in: query
           name: flow
           description: |
@@ -31,11 +32,199 @@ paths:
               - "VALIDATE"
             default: "CONFIRM"
       responses:
+        "200":
+          description: |
+            Dummy response. This is here because of a known bug in the codegen
         "303":
           description: See Others
         "400":
           description: Validation Failed
-        "404":
-          description: Not Found
+  /api/v2/validate-profile-email:
+    get:
+      operationId: getTokenInfo
+      description: |
+        Validates the token and get email relative to a token.
+      parameters:
+        - in: header
+          name: x-pagopa-email-validation-token
+          required: true
+          schema:
+            $ref: "#/components/schemas/ValidationToken"
+      responses:
+        "200":
+          description: Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetTokenInfoResponse'
+        "400":
+          description: Validation failed
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+        "401":
+          description: Invalid token
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedResponse'
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+    post:
+      operationId: validateProfileEmail
+      description: |
+        Validates the token and updates the user profile.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ValidateProfileEmailPayload"
+      responses:
+        "200":
+          description: Status report
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidateProfileStatusReport'
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+        "401":
+          description: Invalid token
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedResponse'
         "500":
           description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+
+components:
+  schemas:
+    GetTokenInfoResponse:
+      oneOf:
+        - type: object
+          properties:
+            status:
+              type: string
+              enum:
+                - SUCCESS
+            profile_email:
+              $ref: "#/components/schemas/ProfileEmail"
+          required:
+            - profile_email
+            - status
+        - $ref: "#/components/schemas/ValidationErrorsObject"
+    UnauthorizedResponse:
+      type: object
+      properties:
+        status:
+          type: string
+          enum:
+            - FAILURE
+        reason:
+          type: string
+          enum:
+            - INVALID_TOKEN
+      required:
+        - status
+        - reason
+    ValidateProfileStatusReport:
+      oneOf:
+        - type: object
+          properties:
+            status:
+              type: string
+              enum:
+                - SUCCESS
+          required:
+            - status
+        - $ref: "#/components/schemas/ValidationErrorsObject"
+    ValidationErrorsObject:
+      type: object
+      properties:
+        status:
+          type: string
+          enum:
+            - FAILURE
+        reason:
+          type: string
+          enum:
+            - TOKEN_EXPIRED
+            - EMAIL_ALREADY_TAKEN
+      required:
+        - status
+        - reason
+    ProfileEmail:
+      type: string
+      format: email
+    ValidationToken:
+      type: string
+      pattern: "^[A-Za-z0-9]{26}:[A-Fa-f0-9]{24}$"
+      example: "01DPT9QAZ6N0FJX21A86FRCWB3:8c652f8566ba53bd8cf0b1b9"
+    ValidateProfileEmailPayload:
+      type: object
+      properties:
+        token:
+          $ref: "#/components/schemas/ValidationToken"
+      required:
+        - token
+    ProblemJson:
+      type: object
+      properties:
+        type:
+          type: string
+          format: uri
+          description: |-
+            An absolute URI that identifies the problem type. When dereferenced,
+            it SHOULD provide human-readable documentation for the problem type
+            (e.g., using HTML).
+          default: about:blank
+          example: https://example.com/problem/constraint-violation
+        title:
+          type: string
+          description: >-
+            A short, summary of the problem type. Written in english and
+            readable
+
+            for engineers (usually not suited for non technical stakeholders and
+
+            not localized); example: Service Unavailable
+        status:
+          type: integer
+          format: int32
+          description: >-
+            The HTTP status code generated by the origin server for this
+            occurrence
+
+            of the problem.
+          minimum: 100
+          maximum: 600
+          exclusiveMaximum: true
+          example: 200
+        detail:
+          type: string
+          description: |-
+            A human readable explanation specific to this occurrence of the
+            problem.
+          example: There was an error processing the request
+        instance:
+          type: string
+          format: uri
+          description: >-
+            An absolute URI that identifies the specific occurrence of the
+            problem.
+
+            It may or may not yield further information if dereferenced.