qaskx
/
qaskx.template
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Switched template definition meaning

main
Tom Peltonen 2025-07-06 09:20:43 +10:00
parent ff420d4b7e
commit e16e01d623
7 changed files with 38 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api/default/error-501.json
View File

@ -19,7 +19,7 @@
], ],
"variables": [ "variables": [
{"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"}, {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"},
{"label": "OpenAPI","source" :"","default":"","name":"name","type":"string","value":"^/.*$"}, {"label": "OpenAPI","source" :"","default":"","name":"path","type":"string","value":"^/.*$"},
{"label": "OpenAPI","source" :"","default":"","name":"method","type":"string","value":"GET, POST, DELETE, PUT, PATCH"}, {"label": "OpenAPI","source" :"","default":"","name":"method","type":"string","value":"GET, POST, DELETE, PUT, PATCH"},
{"label": "OpenAPI","source" :"","default":"","name":"httpCode","type":"string","value":"501"}, {"label": "OpenAPI","source" :"","default":"","name":"httpCode","type":"string","value":"501"},
{"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""},

2
api/default/error-503.json
View File

@ -19,7 +19,7 @@
], ],
"variables": [ "variables": [
{"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"}, {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"},
{"label": "OpenAPI","source" :"","default":"","name":"name","type":"string","value":"^/.*$"}, {"label": "OpenAPI","source" :"","default":"","name":"path","type":"string","value":"^/.*$"},
{"label": "OpenAPI","source" :"","default":"","name":"method","type":"string","value":"GET, POST, DELETE, PUT, PATCH"}, {"label": "OpenAPI","source" :"","default":"","name":"method","type":"string","value":"GET, POST, DELETE, PUT, PATCH"},
{"label": "OpenAPI","source" :"","default":"","name":"httpCode","type":"string","value":"503"}, {"label": "OpenAPI","source" :"","default":"","name":"httpCode","type":"string","value":"503"},
{"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""},

2
api/default/error-path.json
View File

@ -19,7 +19,7 @@
], ],
"variables": [ "variables": [
{"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"}, {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"},
{"label": "OpenAPI","source" :"","default":"","name":"name","type":"string","value":"^/.*$"}, {"label": "OpenAPI","source" :"","default":"","name":"path","type":"string","value":"^/.*$"},
{"label": "OpenAPI","source" :"","default":"","name":"method","type":"string","value":"GET, POST, DELETE, PUT, PATCH"}, {"label": "OpenAPI","source" :"","default":"","name":"method","type":"string","value":"GET, POST, DELETE, PUT, PATCH"},
{"label": "OpenAPI","source" :"","default":"","name":"httpCode","type":"string","value":"500,503"}, {"label": "OpenAPI","source" :"","default":"","name":"httpCode","type":"string","value":"500,503"},
{"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""},

2
api/default/health-patch.json
View File

@ -19,7 +19,7 @@
], ],
"variables": [ "variables": [
{"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-method"}, {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-method"},
{"label": "OpenAPI","source" :"","default":"","name":"name","type":"string","value":"^/health.*$"}, {"label": "OpenAPI","source" :"","default":"","name":"path","type":"string","value":"^/health.*$"},
{"label": "OpenAPI","source" :"","default":"","name":"method","type":"string","value":"PATCH"}, {"label": "OpenAPI","source" :"","default":"","name":"method","type":"string","value":"PATCH"},
{"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"}, {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"},
{"label": "OpenAPI","source" :"","default":"","name":"tag","type":"string","value":"ManageService"} {"label": "OpenAPI","source" :"","default":"","name":"tag","type":"string","value":"ManageService"}

2
api/default/health.json
View File

@ -19,8 +19,8 @@
], ],
"variables": [ "variables": [
{"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path"}, {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path"},
{"label": "OpenAPI","source" :"","default":"","name":"name","type":"string","value":"/healthcheck"},
{"label": "OpenAPI","source" :"","default":"","name":"path","type":"string","value":"/healthcheck"}, {"label": "OpenAPI","source" :"","default":"","name":"path","type":"string","value":"/healthcheck"},
{"label": "OpenAPI","source" :"","default":"","name":"name","type":"string","value":"/healthcheck"},
{"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"}, {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"},
{"label": "OpenAPI","source" :"","default":"","name":"tag","type":"string","value":"ManageService"} {"label": "OpenAPI","source" :"","default":"","name":"tag","type":"string","value":"ManageService"}
] ]

15
api/default/resp-header.json → api/default/reqst-header.json
View File

@ -1,12 +1,12 @@
{ {
"name": "resp-header", "name": "reqst-header",
"guide": "{{.SelfFolder}}/resp-header.md", "guide": "{{.SelfFolder}}/reqst-header.md",
"description": "Response header items for all paths", "description": "Request header items for all paths",
"templates": [ "templates": [
{ {
"engine": "", "engine": "",
"folder": "{{.SelfFolder}}/{{.TemplateName}", "folder": "{{.SelfFolder}}/{{.TemplateName}",
"file_name": "resp-header.tmpl", "file_name": "reqst-header.json",
"output_folder": "", "output_folder": "",
"output_name": "", "output_name": "",
"section": "", "section": "",
@ -18,10 +18,9 @@
} }
], ],
"variables": [ "variables": [
{"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses-header"}, {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-request-header"},
{"label": "OpenAPI","source" :"","default":"","name":"name","type":"string","value":"^/.*$"}, {"label": "OpenAPI","source" :"","default":"","name":"path","type":"string","value":"^/.*$"},
{"label": "OpenAPI","source" :"","default":"","name":"method","type":"string","value":"GET, POST, DELETE, PUT, PATCH"}, {"label": "OpenAPI","source" :"","default":"","name":"name","type":"string","value":"*NONE"},
{"label": "OpenAPI","source" :"","default":"","name":"httpCode","type":"string","value":"200,201,204,400,401,404,500,503"},
{"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"} {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"}
] ]
} }

26
api/default/reqst-header/reqst-header.json 100644
View File

@ -0,0 +1,26 @@
[
{
"name": "X-Correlation-Id",
"description": "A Correlation ID is a unique identifier attached to a request that remains consistent as the request passes through multiple services. It enables developers and DevOps teams to trace the path of a request through logs, metrics, and monitoring tools, regardless of how many microservices are involved.",
"schema": {
"type": "string"
},
"in": "header",
"required": true
},
{
"name": "Brand",
"description": "The brand associated with the request",
"schema": {
"type": "string"
},
"in": "header",
"required": true
},
{
"name": "Platform",
"description": "The platform or channel making the request.\n\nThis is generally the system name or name that an external user\nmight know the web pages by. This could also be the native\nmobile app name.",
"schema": {},
"in": "header"
}
]