weseek__growi/apps/pdf-converter/specs/v3/docs/swagger.json

{
  "openapi": "3.0.1",
  "info": {
    "title": "Api documentation",
    "version": "1.0.0"
  },
  "paths": {
    "/pdf/sync-job": {
      "post": {
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "HTML_EXPORT_IN_PROGRESS",
                        "HTML_EXPORT_DONE",
                        "FAILED",
                        "PDF_EXPORT_DONE"
                      ]
                    }
                  },
                  "required": [
                    "status"
                  ]
                }
              }
            },
            "description": "Accepted"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalServerError"
                }
              }
            },
            "description": "Internal Server Error"
          }
        },
        "description": "\n    Sync job pdf convert status with GROWI.\n    Register or update job inside pdf-converter with given jobId, expirationDate, and status.\n    Return resulting status of job to GROWI.\n  ",
        "parameters": [],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "jobId": {
                    "type": "string"
                  },
                  "expirationDate": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "HTML_EXPORT_IN_PROGRESS",
                      "HTML_EXPORT_DONE",
                      "FAILED"
                    ]
                  }
                },
                "type": "object"
              }
            }
          }
        },
        "tags": [
          "PdfCtrl"
        ],
        "operationId": "pdfCtrlSyncJobStatus"
      }
    }
  },
  "tags": [
    {
      "name": "PdfCtrl"
    }
  ],
  "components": {
    "schemas": {
      "InternalServerError": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "The error name",
            "example": "INTERNAL_SERVER_ERROR",
            "default": "INTERNAL_SERVER_ERROR"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "description": "An error message"
          },
          "status": {
            "type": "number",
            "description": "The status code of the exception",
            "example": 500,
            "default": 500
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GenericError"
            },
            "description": "A list of related errors"
          },
          "stack": {
            "type": "string",
            "description": "The stack trace (only in development mode)"
          }
        },
        "required": [
          "name",
          "message",
          "status"
        ]
      },
      "GenericError": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "The error name"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "description": "An error message"
          }
        },
        "additionalProperties": true,
        "required": [
          "name",
          "message"
        ]
      }
    }
  }
}