pdf_merger__v1.yml

openapi: 3.0.0
info:
  version: "1"
  title: "PDFMerger"
  description: Manifest description
servers:
  - url: http://carriers/openapi/PDFMerger/v1
tags:
  - name: MergeByBag
  - name: MergeBySrOrderNumber
paths:
  "/merge-by-bag":
    post:
      tags:
        - MergeByBag
      summary: "Get packages by bagId and return a label"
      description: ""
      requestBody:
        description: ""
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MergePostRequest'
      responses:
        "200":
          description: "Labels PDF successfully generated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MergeResult'
        "500":
          description: 'Some internal error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
  "/merge-by-sr-order-number":
    post:
      tags:
        - MergeBySrOrderNumber
      summary: "Get packages by SrOrderNumber and return a label"
      description: ""
      requestBody:
        description: ""
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MergePostSrOrderNumberRequest'
      responses:
        "200":
          description: "Labels PDF successfully generated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MergeResult'
        "500":
          description: 'Some internal error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
components:
  schemas:
    # Basic results components
    ErrorResult:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: "#/components/schemas/Message"
      description: "Message field is not required"
    Message:
      type: object
      properties:
        level:
          type: string
          enum:
            - emergency
            - alert
            - critical
            - error
            - warning
            - notice
            - info
        type:
          type: string
          enum:
            - UNDEFINED
            - LOGGER_MESSAGE
          description: >
            You can expose this enum for all your errors
            UNDEFINED - Any undefined message type
            LOGGER_MESSAGE - Same as undefined
        text:
          type: string
          description: Message, that describes what went wrong
    SuccessResult:
      allOf:
        - $ref: '#/components/schemas/ErrorResult'
      type: object
      properties:
        data:
          type: object

    ## One resource result
    MergeResult:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MergedPDF'
          
    MergePostSrOrderNumberRequest:
      type: object
      required:
        - srOrderNumber
      properties:
        srOrderNumber:
          type: string

    ## Body for post request
    MergePostRequest:
      type: object
      required:
        - bagId
      properties:
        bagId:
          type: string

    ## Resource object
    MergedPDF:
      type: object
      properties:
        file:
          type: string
          description: base64 encoded pdf