openapi: 3.0.0
info:
  title: Asset Part Unit API
  description: API for managing asset part units (individual instances of parts)
  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 Unit
    description: Operations related to asset part unit management

paths:
  /asset-part-unit:
    get:
      tags:
        - Asset Part Unit
      summary: Get all asset part units
      description: Retrieve a list of all asset part units 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 units retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/AssetPartUnit"
                  total:
                    type: integer
                    description: Total number of records
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "500":
          description: Internal server error
    post:
      tags:
        - Asset Part Unit
      summary: Create a new asset part unit
      description: Create a new asset part unit with the provided data
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AssetPartUnitInput"
      responses:
        "201":
          description: Asset part unit created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: "#/components/schemas/AssetPartUnit"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "500":
          description: Internal server error

  /asset-part-unit/{id}:
    get:
      tags:
        - Asset Part Unit
      summary: Get asset part unit by ID
      description: Retrieve a specific asset part unit by its ID
      parameters:
        - name: id
          in: path
          required: true
          description: Asset part unit ID
          schema:
            type: string
      responses:
        "200":
          description: Asset part unit retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: "#/components/schemas/AssetPartUnit"
        "404":
          description: Asset part unit not found
        "401":
          description: Unauthorized
        "500":
          description: Internal server error
    put:
      tags:
        - Asset Part Unit
      summary: Update asset part unit
      description: Update an existing asset part unit with new data
      parameters:
        - name: id
          in: path
          required: true
          description: Asset part unit ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AssetPartUnitInput"
      responses:
        "200":
          description: Asset part unit updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: "#/components/schemas/AssetPartUnit"
        "400":
          description: Bad request
        "404":
          description: Asset part unit not found
        "401":
          description: Unauthorized
        "500":
          description: Internal server error
    delete:
      tags:
        - Asset Part Unit
      summary: Delete asset part unit
      description: Delete an existing asset part unit
      parameters:
        - name: id
          in: path
          required: true
          description: Asset part unit ID
          schema:
            type: string
      responses:
        "200":
          description: Asset part unit deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Asset part unit deleted successfully
        "404":
          description: Asset part unit not found
        "401":
          description: Unauthorized
        "500":
          description: Internal server error

components:
  schemas:
    AssetPartUnit:
      type: object
      properties:
        _id:
          type: string
          description: Unique identifier for the asset part unit
          example: "60f7b1b3e4b0e8b3f8b3f8b3"
        serialNumber:
          type: string
          description: Serial number of the part unit
          example: "SN-EP001-2023-001"
        assetPart:
          type: string
          description: Asset part ID this unit belongs to
          example: "60f7b1b3e4b0e8b3f8b3f8b4"
        batchNumber:
          type: string
          description: Batch number
          example: "BATCH-2023-001"
        lotNumber:
          type: string
          description: Lot number
        manufactureDate:
          type: string
          format: date
          description: Manufacturing date
          example: "2023-01-15"
        expiryDate:
          type: string
          format: date
          description: Expiry date (if applicable)
        receiptDate:
          type: string
          format: date-time
          description: Date when the unit was received
          example: "2023-01-20T10:00:00Z"
        status:
          type: string
          enum: [available, reserved, in-use, maintenance, disposed, returned]
          default: available
          description: Current status of the part unit
        condition:
          type: string
          enum: [new, good, fair, poor, damaged]
          default: new
          description: Physical condition of the part unit
        location:
          type: object
          properties:
            warehouse:
              type: string
              description: Warehouse ID
            section:
              type: string
              description: Section within warehouse
            shelf:
              type: string
              description: Shelf identifier
            position:
              type: string
              description: Position on shelf
        assignedTo:
          type: object
          properties:
            asset:
              type: string
              description: Asset ID if installed
            workOrder:
              type: string
              description: Work order ID if assigned
            technician:
              type: string
              description: Technician ID if assigned
            date:
              type: string
              format: date-time
              description: Assignment date
        installationDate:
          type: string
          format: date-time
          description: Date when the unit was installed
        lastMaintenanceDate:
          type: string
          format: date-time
          description: Last maintenance date
        nextMaintenanceDate:
          type: string
          format: date-time
          description: Next scheduled maintenance date
        warrantyExpiry:
          type: string
          format: date
          description: Warranty expiry date
        cost:
          type: number
          format: double
          minimum: 0
          description: Cost of this specific unit
        supplier:
          type: string
          description: Supplier ID
        purchaseOrder:
          type: string
          description: Purchase order reference
        invoice:
          type: string
          description: Invoice reference
        notes:
          type: string
          description: Additional notes
        maintenanceHistory:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
                format: date-time
              type:
                type: string
                enum: [inspection, repair, replacement, upgrade]
              description:
                type: string
              technician:
                type: string
              cost:
                type: number
                format: double
        customFields:
          type: object
          additionalProperties: true
          description: Custom fields
        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:
        - serialNumber
        - assetPart
        - status

    AssetPartUnitInput:
      type: object
      properties:
        serialNumber:
          type: string
          description: Serial number of the part unit
          example: "SN-EP001-2023-001"
        assetPart:
          type: string
          description: Asset part ID this unit belongs to
          example: "60f7b1b3e4b0e8b3f8b3f8b4"
        batchNumber:
          type: string
          description: Batch number
          example: "BATCH-2023-001"
        lotNumber:
          type: string
          description: Lot number
        manufactureDate:
          type: string
          format: date
          description: Manufacturing date
          example: "2023-01-15"
        expiryDate:
          type: string
          format: date
          description: Expiry date (if applicable)
        receiptDate:
          type: string
          format: date-time
          description: Date when the unit was received
          example: "2023-01-20T10:00:00Z"
        status:
          type: string
          enum: [available, reserved, in-use, maintenance, disposed, returned]
          default: available
          description: Current status of the part unit
        condition:
          type: string
          enum: [new, good, fair, poor, damaged]
          default: new
          description: Physical condition of the part unit
        location:
          type: object
          properties:
            warehouse:
              type: string
              description: Warehouse ID
            section:
              type: string
              description: Section within warehouse
            shelf:
              type: string
              description: Shelf identifier
            position:
              type: string
              description: Position on shelf
        assignedTo:
          type: object
          properties:
            asset:
              type: string
              description: Asset ID if installed
            workOrder:
              type: string
              description: Work order ID if assigned
            technician:
              type: string
              description: Technician ID if assigned
            date:
              type: string
              format: date-time
              description: Assignment date
        installationDate:
          type: string
          format: date-time
          description: Date when the unit was installed
        lastMaintenanceDate:
          type: string
          format: date-time
          description: Last maintenance date
        nextMaintenanceDate:
          type: string
          format: date-time
          description: Next scheduled maintenance date
        warrantyExpiry:
          type: string
          format: date
          description: Warranty expiry date
        cost:
          type: number
          format: double
          minimum: 0
          description: Cost of this specific unit
        supplier:
          type: string
          description: Supplier ID
        purchaseOrder:
          type: string
          description: Purchase order reference
        invoice:
          type: string
          description: Invoice reference
        notes:
          type: string
          description: Additional notes
        customFields:
          type: object
          additionalProperties: true
          description: Custom fields
        metadata:
          type: object
          additionalProperties: true
          description: Additional metadata
      required:
        - serialNumber
        - assetPart
        - status

  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key

security:
  - ApiKeyAuth: []
