repzo 1.0.155 → 1.0.157

package/src/oas/update-integration-meta.yaml

@@ -0,0 +1,387 @@
+openapi: 3.0.0
+info:
+  title: Update Integration Meta API
+  description: API for managing integration metadata updates
+  version: 1.0.0
+  contact:
+    name: Repzo
+    url: https://repzo.com
+
+servers:
+  - url: https://sv.api.repzo.me
+    description: Production server
+  - url: https://staging.sv.api.repzo.me
+    description: Staging server
+
+tags:
+  - name: Update Integration Meta
+    description: Operations related to updating integration metadata
+
+paths:
+  /update-integration-meta:
+    get:
+      tags:
+        - Update Integration Meta
+      summary: Get all integration meta update records
+      description: Retrieve a list of all integration metadata update records with optional filtering and pagination
+      parameters:
+        - name: limit
+          in: query
+          description: Maximum number of records to return
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 50
+        - name: offset
+          in: query
+          description: Number of records to skip for pagination
+          required: false
+          schema:
+            type: integer
+            minimum: 0
+            default: 0
+        - name: sort
+          in: query
+          description: Field to sort by
+          required: false
+          schema:
+            type: string
+        - name: order
+          in: query
+          description: Sort order (asc or desc)
+          required: false
+          schema:
+            type: string
+            enum: [asc, desc]
+            default: desc
+        - name: filter
+          in: query
+          description: Filter conditions in JSON format
+          required: false
+          schema:
+            type: string
+        - name: search
+          in: query
+          description: Search term for text fields
+          required: false
+          schema:
+            type: string
+      responses:
+        "200":
+          description: List of integration meta update records retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/UpdateIntegrationMeta"
+                  total:
+                    type: integer
+                    description: Total number of records
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    post:
+      tags:
+        - Update Integration Meta
+      summary: Create a new integration meta update
+      description: Create a new integration metadata update with the provided data
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateIntegrationMetaInput"
+      responses:
+        "201":
+          description: Integration meta update created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/UpdateIntegrationMeta"
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+  /update-integration-meta/{id}:
+    get:
+      tags:
+        - Update Integration Meta
+      summary: Get integration meta update by ID
+      description: Retrieve a specific integration metadata update by its ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Integration meta update ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Integration meta update retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/UpdateIntegrationMeta"
+        "404":
+          description: Integration meta update not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    put:
+      tags:
+        - Update Integration Meta
+      summary: Update integration meta update
+      description: Update an existing integration metadata update with new data
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Integration meta update ID
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateIntegrationMetaInput"
+      responses:
+        "200":
+          description: Integration meta update updated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/UpdateIntegrationMeta"
+        "400":
+          description: Bad request
+        "404":
+          description: Integration meta update not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    delete:
+      tags:
+        - Update Integration Meta
+      summary: Delete integration meta update
+      description: Delete an existing integration metadata update
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Integration meta update ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Integration meta update deleted successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  message:
+                    type: string
+                    example: Integration meta update deleted successfully
+        "404":
+          description: Integration meta update not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+  /update-integration-meta/apply/{id}:
+    post:
+      tags:
+        - Update Integration Meta
+      summary: Apply integration meta update
+      description: Apply a specific integration metadata update
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Integration meta update ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Integration meta update applied successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    type: object
+                    properties:
+                      appliedAt:
+                        type: string
+                        format: date-time
+                      affectedIntegrations:
+                        type: integer
+        "404":
+          description: Integration meta update not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+    UpdateIntegrationMeta:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the integration meta update
+          example: "60f7b1b3e4b0e8b3f8b3f8b3"
+        name:
+          type: string
+          description: Name of the meta update
+          example: "Update API Version"
+        description:
+          type: string
+          description: Description of the meta update
+        targetIntegrations:
+          type: array
+          items:
+            type: string
+          description: List of integration IDs to update
+        metaUpdates:
+          type: object
+          additionalProperties: true
+          description: Metadata fields to update
+          example:
+            apiVersion: "v2.0"
+            timeout: 30000
+            retryCount: 3
+        conditions:
+          type: object
+          additionalProperties: true
+          description: Conditions for applying the update
+        status:
+          type: string
+          enum: [draft, ready, applied, failed, cancelled]
+          default: draft
+          description: Status of the meta update
+        appliedAt:
+          type: string
+          format: date-time
+          description: When the update was applied
+        appliedBy:
+          type: string
+          description: User who applied the update
+        affectedCount:
+          type: integer
+          minimum: 0
+          description: Number of integrations affected
+        rollbackData:
+          type: object
+          additionalProperties: true
+          description: Data needed for rollback
+        metadata:
+          type: object
+          additionalProperties: true
+          description: Additional metadata
+        createdAt:
+          type: string
+          format: date-time
+          description: Record creation timestamp
+          example: "2023-01-15T08:00:00Z"
+        updatedAt:
+          type: string
+          format: date-time
+          description: Record last update timestamp
+          example: "2023-01-15T10:30:00Z"
+      required:
+        - name
+        - metaUpdates
+
+    UpdateIntegrationMetaInput:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Name of the meta update
+          example: "Update API Version"
+        description:
+          type: string
+          description: Description of the meta update
+        targetIntegrations:
+          type: array
+          items:
+            type: string
+          description: List of integration IDs to update
+        metaUpdates:
+          type: object
+          additionalProperties: true
+          description: Metadata fields to update
+          example:
+            apiVersion: "v2.0"
+            timeout: 30000
+            retryCount: 3
+        conditions:
+          type: object
+          additionalProperties: true
+          description: Conditions for applying the update
+        status:
+          type: string
+          enum: [draft, ready, applied, failed, cancelled]
+          default: draft
+          description: Status of the meta update
+        metadata:
+          type: object
+          additionalProperties: true
+          description: Additional metadata
+      required:
+        - name
+        - metaUpdates
+
+  securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: api-key
+
+security:
+  - ApiKeyAuth: []