office2pdf/openapi.yaml at main · codeinchq/office2pdf · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
swagger: '2.0'
info:
  title: Office2Pdf v1 EU API
  description: Converts .docx files to .pdf files.
  version: 1.0.0
schemes:
  - https
produces:
  - application/pdf
paths:
  /convert:
    post:
      operationId: convertDocxToPdf
      summary: "Convert .docx to .pdf"
      description: "Uploads a .docx file and returns a converted .pdf file."
      consumes:
        - multipart/form-data
      produces:
        - application/pdf
      parameters:
        - in: formData
          name: file
          description: "The .docx file to be converted."
          required: true
          type: string
      responses:
        200:
          description: "Successfully converted the file."
          schema:
            type: string
          headers:
            Content-Disposition:
              type: string
              description: 'Indicates the filename for the converted file, e.g., "example.pdf".'
        400:
          description: "Bad request. The input file is invalid or missing."
        500:
          description: "Internal server error. Conversion failed."
  /health:
    get:
      operationId: healthCheck
      summary: "Health check endpoint"
      description: "Returns a plain text response indicating the service is running."
      produces:
        - text/plain
      responses:
        200:
          description: "Service is running and returns 'ok'."
          schema:
            type: string