eltemplito/swagger.yaml at master · andrba/eltemplito · 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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
openapi: "3.0.0"
info:
  title: "eltemplito-api"
  version: "1"

x-amazon-apigateway-request-validators:
  full:
    validateRequestBody: true
    validateRequestParameters: true

x-amazon-apigateway-request-validator: full

paths:
  /documents:
    post:
      description: >-
        Request document creation. It takes a JSON
        object containing a template url, an output format and an
        optional JSON object with merge fields.
      x-amazon-apigateway-integration:
        uri:
          Fn::Sub: "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${CreateDocumentFunction.Arn}/invocations"
        passthroughBehavior: never
        httpMethod: POST
        type: aws_proxy
      summary: Create a New Document
      operationId: createDocument
      requestBody:
        $ref: '#/components/requestBodies/Document'
      responses:
        202:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: '0e1a0d0e-2e38-4e7a-a060-540a5c6865a4'
                  status:
                    type: string
                    enum:
                      - pending
                      - error

externalDocs:
  description: Find out more about Eltemplito
  url: 'https://github.com/andrba/eltemplito'

components:
  requestBodies:
    Document:
      content:
        application/json:
          schema:
            type: object
            properties:
              file_url:
                type: string
                example: 'https://my-app.com/templates/template.yml'
              output_format:
                type: string
                enum:
                  - docx
                  - pdf
                example: 'pdf'
              merge_fields:
                type: object
                example:
                  content: 'The best things in life are not things'