mod-template-engine/ramls/template-engine.raml at 66a638db1ccbb758db9062dd05d9cc081c226a41 · folio-org/mod-template-engine · 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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
#%RAML 1.0

title: Template engine
baseUri: http://api.example.com/{version}
version: v2.2


documentation:
  - title: mod-template-engine API
    content: This module dedicated for storing templates and generating text, html, xml, doc, docx etc from the template.

types:
  template: !include template.json
  templatesCollection: !include templatesCollection.json
  templateProcessingRequest: !include templateProcessingRequest.json
  templateProcessingResult: !include templateProcessingResult.json
  errors: !include raml-util/schemas/errors.schema

traits:
  pageable: !include ./raml-util/traits/pageable.raml
  queryable:
      queryParameters:
        query:
          description: "A query string to filter templates based on matching criteria in fields."
          required: false
          type: string
  validate: !include ./raml-util/traits/validation.raml

/templates:
  post:
    is: [validate]
    description: Add a new template
    body:
      application/json:
        type: template
    responses:
      201:
        body:
          application/json:
            type: template
      400:
        description: "Bad request"
        body:
          text/plain:
            example: "Bad request"
      500:
        description: "Internal server error"
        body:
          text/plain:
            example: "Internal server error"
  get:
    description: Get a list of templates
    is: [
      pageable,
      queryable
    ]
    responses:
      200:
        body:
          application/json:
            type: templatesCollection
      400:
        description: "Bad request"
        body:
          text/plain:
            example: "Bad request"
      500:
        description: "Internal server error"
        body:
          text/plain:
            example: "Internal server error"
  /{templateId}:
    get:
      description: Get template by id
      responses:
        200:
          body:
            application/json:
              type: template
        404:
          description: "Template not found"
          body:
            text/plain:
              example: "Template not found"
        500:
          description: "Internal server error"
          body:
            text/plain:
              example: "Internal server error"
    put:
      description: Modify a template
      body:
        application/json:
         type: template
      responses:
        200:
          body:
            application/json:
              type: template
        404:
          description: "Template not found"
          body:
            text/plain:
                example: "Template not found"
        500:
          description: "Internal server error"
          body:
            text/plain:
              example: "Internal server error"
    delete:
      description: Delete template by id
      responses:
        204:
          body:
            text/plain: !!null
        404:
          description: "Template not found"
          body:
            text/plain:
              example: "Template not found"
        500:
          description: "Internal server error"
          body:
            text/plain:
              example: "Internal server error"
/template-request:
  post:
    is: [validate]
    description: process specified template using given context
    body:
      application/json:
        type: templateProcessingRequest
    responses:
      200:
        body:
          application/json:
            type: templateProcessingResult
      400:
        body:
          text/plain:
            example: "Bad request"
      500:
        body:
          text/plain:
            example: "Internal server error"