repzo 1.0.155 → 1.0.156

package/src/oas/asset-part-type.yaml

@@ -0,0 +1,383 @@
+openapi: 3.0.0
+info:
+  title: Asset Part Type API
+  description: API for managing asset part types
+  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: Asset Part Type
+    description: Operations related to asset part type management
+
+paths:
+  /asset-part-type:
+    get:
+      tags:
+        - Asset Part Type
+      summary: Get all asset part types
+      description: Retrieve a list of all asset part types 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 asset part types retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/AssetPartType"
+                  total:
+                    type: integer
+                    description: Total number of records
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    post:
+      tags:
+        - Asset Part Type
+      summary: Create a new asset part type
+      description: Create a new asset part type with the provided data
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AssetPartTypeInput"
+      responses:
+        "201":
+          description: Asset part type created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/AssetPartType"
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+  /asset-part-type/{id}:
+    get:
+      tags:
+        - Asset Part Type
+      summary: Get asset part type by ID
+      description: Retrieve a specific asset part type by its ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part type ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Asset part type retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/AssetPartType"
+        "404":
+          description: Asset part type not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    put:
+      tags:
+        - Asset Part Type
+      summary: Update asset part type
+      description: Update an existing asset part type with new data
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part type ID
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AssetPartTypeInput"
+      responses:
+        "200":
+          description: Asset part type updated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/AssetPartType"
+        "400":
+          description: Bad request
+        "404":
+          description: Asset part type not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    delete:
+      tags:
+        - Asset Part Type
+      summary: Delete asset part type
+      description: Delete an existing asset part type
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part type ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Asset part type deleted successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  message:
+                    type: string
+                    example: Asset part type deleted successfully
+        "404":
+          description: Asset part type not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+    AssetPartType:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the asset part type
+          example: "60f7b1b3e4b0e8b3f8b3f8b3"
+        name:
+          type: string
+          description: Name of the asset part type
+          example: "Engine Parts"
+        description:
+          type: string
+          description: Description of the asset part type
+        category:
+          type: string
+          description: Category of the asset part type
+          example: "Mechanical"
+        subcategory:
+          type: string
+          description: Subcategory of the asset part type
+        specifications:
+          type: object
+          additionalProperties: true
+          description: Technical specifications
+          example:
+            material: "Steel"
+            dimensions: "10x5x2 cm"
+            weight: "0.5 kg"
+        compatibleAssetTypes:
+          type: array
+          items:
+            type: string
+          description: List of compatible asset type IDs
+        maintenanceSchedule:
+          type: object
+          properties:
+            frequency:
+              type: string
+              enum: [daily, weekly, monthly, quarterly, annually]
+            intervalDays:
+              type: integer
+              minimum: 1
+            description:
+              type: string
+        warrantPeriod:
+          type: integer
+          description: Warranty period in days
+          example: 365
+        supplier:
+          type: string
+          description: Default supplier ID
+        standardCost:
+          type: number
+          format: double
+          minimum: 0
+          description: Standard cost of the part
+        isActive:
+          type: boolean
+          default: true
+          description: Whether the part type is active
+        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
+        - category
+
+    AssetPartTypeInput:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Name of the asset part type
+          example: "Engine Parts"
+        description:
+          type: string
+          description: Description of the asset part type
+        category:
+          type: string
+          description: Category of the asset part type
+          example: "Mechanical"
+        subcategory:
+          type: string
+          description: Subcategory of the asset part type
+        specifications:
+          type: object
+          additionalProperties: true
+          description: Technical specifications
+          example:
+            material: "Steel"
+            dimensions: "10x5x2 cm"
+            weight: "0.5 kg"
+        compatibleAssetTypes:
+          type: array
+          items:
+            type: string
+          description: List of compatible asset type IDs
+        maintenanceSchedule:
+          type: object
+          properties:
+            frequency:
+              type: string
+              enum: [daily, weekly, monthly, quarterly, annually]
+            intervalDays:
+              type: integer
+              minimum: 1
+            description:
+              type: string
+        warrantPeriod:
+          type: integer
+          description: Warranty period in days
+          example: 365
+        supplier:
+          type: string
+          description: Default supplier ID
+        standardCost:
+          type: number
+          format: double
+          minimum: 0
+          description: Standard cost of the part
+        isActive:
+          type: boolean
+          default: true
+          description: Whether the part type is active
+        metadata:
+          type: object
+          additionalProperties: true
+          description: Additional metadata
+      required:
+        - name
+        - category
+
+  securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: api-key
+
+security:
+  - ApiKeyAuth: []