https://github.com/koevskinikola/camunda-open-api-endpoints
Create a proper structure and FTL templates for the Camunda OpenAPI spec
https://github.com/koevskinikola/camunda-open-api-endpoints
camunda-bpm-platform freemarker openapi3
Last synced: 7 months ago
JSON representation
Create a proper structure and FTL templates for the Camunda OpenAPI spec
- Host: GitHub
- URL: https://github.com/koevskinikola/camunda-open-api-endpoints
- Owner: koevskinikola
- License: apache-2.0
- Created: 2020-03-16T15:42:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-19T09:20:05.000Z (over 5 years ago)
- Last Synced: 2025-01-23T01:30:34.928Z (9 months ago)
- Topics: camunda-bpm-platform, freemarker, openapi3
- Language: Shell
- Homepage: https://github.com/camunda/camunda-bpm-platform/tree/master/engine-rest/engine-rest-openapi
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# camunda-open-api-endpoints
Scripts to create the proper structure and FTL template files for the Camunda Open API spec
The `endpoints.sh` bash script has the following format:
```sh
./endpoints.sh [http_verb] [space_separated_enpoint_paths]
```
For example, the call to `./endpoints.sh get task/{id}/complete task/{id}/assign`
in a given directory, will produce the following folder structure:
* PARENT_DIRECTORY
* task
* {id}
* complete
* get.ftl
* assign
* get.ftl
The `\*.ftl` files listed above will contain the following content:
```xml
{
<@lib.endpointInfo
id = "ADD_ID"
tag = "ADD_TAG"
desc = "" />
"parameters" : [
<@lib.parameter
name = "id"
location = "path"
type = "string"
required = true
last = true
desc = "The id of the ADD_TYPE for which ENTER_DESC should be ADD_ACTION."/>
<#assign last = true >
<#include "/lib/commons/pagination-params.ftl" >
],
<@lib.requestBody
mediaType = "application/json"
dto = "_Dto"
examples = ['"example-1": {
"summary": "",
"description": "",
"value":
}'] />
"responses" : {
<@lib.response
code = "200"
dto = "ADD_DTO"
array = true
desc = "Request successful." />
<@lib.response
code = "400"
dto = "ExceptionDto"
last = true
desc = "Bad Request. See the
[Introduction](${docsUrl}/reference/rest/overview/#error-handling)
for the error response format." />
}
}
```