diff --git a/api/default/error-501.json b/api/default/error-501.json index 49c0d59..37a61a3 100644 --- a/api/default/error-501.json +++ b/api/default/error-501.json @@ -19,7 +19,7 @@ ], "variables": [ {"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":"httpCode","type":"string","value":"501"}, {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, diff --git a/api/default/error-503.json b/api/default/error-503.json index d4c9510..f4e93b8 100644 --- a/api/default/error-503.json +++ b/api/default/error-503.json @@ -19,7 +19,7 @@ ], "variables": [ {"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":"httpCode","type":"string","value":"503"}, {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, diff --git a/api/default/error-path.json b/api/default/error-path.json index 9a36d25..0e54f34 100644 --- a/api/default/error-path.json +++ b/api/default/error-path.json @@ -19,7 +19,7 @@ ], "variables": [ {"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":"httpCode","type":"string","value":"500,503"}, {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, diff --git a/api/default/health-patch.json b/api/default/health-patch.json index 03607ec..5360567 100644 --- a/api/default/health-patch.json +++ b/api/default/health-patch.json @@ -19,7 +19,7 @@ ], "variables": [ {"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":"value","type":"string","value":"*CONTENT"}, {"label": "OpenAPI","source" :"","default":"","name":"tag","type":"string","value":"ManageService"} diff --git a/api/default/health.json b/api/default/health.json index a0dec1a..8ca9306 100644 --- a/api/default/health.json +++ b/api/default/health.json @@ -19,8 +19,8 @@ ], "variables": [ {"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":"name","type":"string","value":"/healthcheck"}, {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"}, {"label": "OpenAPI","source" :"","default":"","name":"tag","type":"string","value":"ManageService"} ] diff --git a/api/default/resp-header.json b/api/default/reqst-header.json similarity index 53% rename from api/default/resp-header.json rename to api/default/reqst-header.json index 7d73d2a..f78e944 100644 --- a/api/default/resp-header.json +++ b/api/default/reqst-header.json @@ -1,12 +1,12 @@ { - "name": "resp-header", - "guide": "{{.SelfFolder}}/resp-header.md", - "description": "Response header items for all paths", + "name": "reqst-header", + "guide": "{{.SelfFolder}}/reqst-header.md", + "description": "Request header items for all paths", "templates": [ { "engine": "", "folder": "{{.SelfFolder}}/{{.TemplateName}", - "file_name": "resp-header.tmpl", + "file_name": "reqst-header.json", "output_folder": "", "output_name": "", "section": "", @@ -18,10 +18,9 @@ } ], "variables": [ - {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses-header"}, - {"label": "OpenAPI","source" :"","default":"","name":"name","type":"string","value":"^/.*$"}, - {"label": "OpenAPI","source" :"","default":"","name":"method","type":"string","value":"GET, POST, DELETE, PUT, PATCH"}, - {"label": "OpenAPI","source" :"","default":"","name":"httpCode","type":"string","value":"200,201,204,400,401,404,500,503"}, + {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-request-header"}, + {"label": "OpenAPI","source" :"","default":"","name":"path","type":"string","value":"^/.*$"}, + {"label": "OpenAPI","source" :"","default":"","name":"name","type":"string","value":"*NONE"}, {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"} ] } diff --git a/api/default/reqst-header/reqst-header.json b/api/default/reqst-header/reqst-header.json new file mode 100644 index 0000000..5cd790d --- /dev/null +++ b/api/default/reqst-header/reqst-header.json @@ -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" + } + ] \ No newline at end of file