From 23fe8a5bc6d622e21d30348072402303195b14d0 Mon Sep 17 00:00:00 2001 From: Tom Peltonen Date: Sun, 6 Jul 2025 16:06:58 +1000 Subject: [PATCH] Added and simplified error code templates --- api/default/error-400.json | 28 ++++++++++++++++++++++ api/default/error-401.json | 28 ++++++++++++++++++++++ api/default/error-403.json | 28 ++++++++++++++++++++++ api/default/error-404.json | 28 ++++++++++++++++++++++ api/default/error-405.json | 28 ++++++++++++++++++++++ api/default/error-4nn.md | 35 ++++++++++++++++++++++++++++ api/default/error-500.json | 28 ++++++++++++++++++++++ api/default/error-501.json | 6 ++--- api/default/error-501.md | 6 ----- api/default/error-501/error-nnn.tmpl | 10 -------- api/default/error-503.json | 6 ++--- api/default/error-503.md | 6 ----- api/default/error-503/error-nnn.tmpl | 10 -------- api/default/error-5nn.md | 22 +++++++++++++++++ api/default/error-nnn/error-400.json | 10 ++++++++ api/default/error-nnn/error-401.json | 10 ++++++++ api/default/error-nnn/error-403.json | 10 ++++++++ api/default/error-nnn/error-404.json | 10 ++++++++ api/default/error-nnn/error-405.json | 10 ++++++++ api/default/error-nnn/error-410.json | 10 ++++++++ api/default/error-nnn/error-4nn.json | 10 ++++++++ api/default/error-nnn/error-500.json | 10 ++++++++ api/default/error-nnn/error-501.json | 10 ++++++++ api/default/error-nnn/error-503.json | 10 ++++++++ api/default/error-nnn/error-5nn.json | 10 ++++++++ 25 files changed, 341 insertions(+), 38 deletions(-) create mode 100644 api/default/error-400.json create mode 100644 api/default/error-401.json create mode 100644 api/default/error-403.json create mode 100644 api/default/error-404.json create mode 100644 api/default/error-405.json create mode 100644 api/default/error-4nn.md create mode 100644 api/default/error-500.json delete mode 100644 api/default/error-501.md delete mode 100644 api/default/error-501/error-nnn.tmpl delete mode 100644 api/default/error-503.md delete mode 100644 api/default/error-503/error-nnn.tmpl create mode 100644 api/default/error-5nn.md create mode 100644 api/default/error-nnn/error-400.json create mode 100644 api/default/error-nnn/error-401.json create mode 100644 api/default/error-nnn/error-403.json create mode 100644 api/default/error-nnn/error-404.json create mode 100644 api/default/error-nnn/error-405.json create mode 100644 api/default/error-nnn/error-410.json create mode 100644 api/default/error-nnn/error-4nn.json create mode 100644 api/default/error-nnn/error-500.json create mode 100644 api/default/error-nnn/error-501.json create mode 100644 api/default/error-nnn/error-503.json create mode 100644 api/default/error-nnn/error-5nn.json diff --git a/api/default/error-400.json b/api/default/error-400.json new file mode 100644 index 0000000..c425b24 --- /dev/null +++ b/api/default/error-400.json @@ -0,0 +1,28 @@ +{ + "name": "error-400", + "guide": "{{.SelfFolder}}/error-4nn.md", + "description": "400 error response", + "templates": [ + { + "engine": "", + "folder": "{{.SelfFolder}}/error-nnn", + "file_name": "error-400.json", + "output_folder": "", + "output_name": "", + "section": "", + "model": { + "activity": { + "category": "OTHER" + } + } + } + ], + "variables": [ + {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"}, + {"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":"400"}, + {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, + {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"} + ] +} diff --git a/api/default/error-401.json b/api/default/error-401.json new file mode 100644 index 0000000..4326b12 --- /dev/null +++ b/api/default/error-401.json @@ -0,0 +1,28 @@ +{ + "name": "error-401", + "guide": "{{.SelfFolder}}/error-4nn.md", + "description": "401 error response", + "templates": [ + { + "engine": "", + "folder": "{{.SelfFolder}}/error-nnn", + "file_name": "error-401.json", + "output_folder": "", + "output_name": "", + "section": "", + "model": { + "activity": { + "category": "OTHER" + } + } + } + ], + "variables": [ + {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"}, + {"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":"401"}, + {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, + {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"} + ] +} diff --git a/api/default/error-403.json b/api/default/error-403.json new file mode 100644 index 0000000..90100c9 --- /dev/null +++ b/api/default/error-403.json @@ -0,0 +1,28 @@ +{ + "name": "error-403", + "guide": "{{.SelfFolder}}/error-4nn.md", + "description": "403 error response", + "templates": [ + { + "engine": "", + "folder": "{{.SelfFolder}}/error-nnn", + "file_name": "error-403.json", + "output_folder": "", + "output_name": "", + "section": "", + "model": { + "activity": { + "category": "OTHER" + } + } + } + ], + "variables": [ + {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"}, + {"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":"403"}, + {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, + {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"} + ] +} diff --git a/api/default/error-404.json b/api/default/error-404.json new file mode 100644 index 0000000..9d0af71 --- /dev/null +++ b/api/default/error-404.json @@ -0,0 +1,28 @@ +{ + "name": "error-404", + "guide": "{{.SelfFolder}}/error-4nn.md", + "description": "404 error response", + "templates": [ + { + "engine": "", + "folder": "{{.SelfFolder}}/error-nnn", + "file_name": "error-404.json", + "output_folder": "", + "output_name": "", + "section": "", + "model": { + "activity": { + "category": "OTHER" + } + } + } + ], + "variables": [ + {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"}, + {"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":"404"}, + {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, + {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"} + ] +} diff --git a/api/default/error-405.json b/api/default/error-405.json new file mode 100644 index 0000000..5a5beda --- /dev/null +++ b/api/default/error-405.json @@ -0,0 +1,28 @@ +{ + "name": "error-405", + "guide": "{{.SelfFolder}}/error-4nn.md", + "description": "405 error response", + "templates": [ + { + "engine": "", + "folder": "{{.SelfFolder}}/error-nnn", + "file_name": "error-405.json", + "output_folder": "", + "output_name": "", + "section": "", + "model": { + "activity": { + "category": "OTHER" + } + } + } + ], + "variables": [ + {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"}, + {"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":"405"}, + {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, + {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"} + ] +} diff --git a/api/default/error-4nn.md b/api/default/error-4nn.md new file mode 100644 index 0000000..aeeb0f7 --- /dev/null +++ b/api/default/error-4nn.md @@ -0,0 +1,35 @@ +# 4nn Client errors + +## 400 Bad request + +The HTTP code 400 indicates that the server could not understand the request due to incorrect syntax. +The client should NOT repeat the request without modifications. + +For more information see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/501](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/400) + +## 401 Unauthorized + +The HTTP code 401 indicates that the request requires user authentication information. +The client MAY repeat the request with a suitable Authorization header field + +For more information see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/501](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/401) + +## 403 Forbidden + +The HTTP code 403 indicates that the client does not have access rights to the content. +Unlike 401, the client’s identity is known to the server. + +For more information see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/501](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/403) + +## 404 Not Found + +The HTTP code 404 indicates that the server can not find the requested resource. + +For more information see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/501](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/404) + +## 405 Method Not Allowed + +The HTTP code 405 indicates that the server could not understand the request due to incorrect syntax. +The client should NOT repeat the request without modifications. + +For more information see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/501](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/405) diff --git a/api/default/error-500.json b/api/default/error-500.json new file mode 100644 index 0000000..bf217c3 --- /dev/null +++ b/api/default/error-500.json @@ -0,0 +1,28 @@ +{ + "name": "error-500", + "guide": "{{.SelfFolder}}/error-5nn.md", + "description": "500 error response", + "templates": [ + { + "engine": "", + "folder": "{{.SelfFolder}}/error-nnn", + "file_name": "error-500.json", + "output_folder": "", + "output_name": "", + "section": "", + "model": { + "activity": { + "category": "OTHER" + } + } + } + ], + "variables": [ + {"label": "OpenAPI","source" :"","default":"","name":"openapi.type","type":"string","value":"path-responses"}, + {"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"}, + {"label": "OpenAPI","source" :"","default":"","name":"ref","type":"string","value":""}, + {"label": "OpenAPI","source" :"","default":"","name":"value","type":"string","value":"*CONTENT"} + ] +} diff --git a/api/default/error-501.json b/api/default/error-501.json index 37a61a3..47989fe 100644 --- a/api/default/error-501.json +++ b/api/default/error-501.json @@ -1,12 +1,12 @@ { "name": "error-501", - "guide": "{{.SelfFolder}}/error-501.md", + "guide": "{{.SelfFolder}}/error-5nn.md", "description": "503 error response", "templates": [ { "engine": "", - "folder": "{{.SelfFolder}}/{{.TemplateName}", - "file_name": "error-nnn.tmpl", + "folder": "{{.SelfFolder}}/error-nnn", + "file_name": "error-501.json", "output_folder": "", "output_name": "", "section": "", diff --git a/api/default/error-501.md b/api/default/error-501.md deleted file mode 100644 index bd18613..0000000 --- a/api/default/error-501.md +++ /dev/null @@ -1,6 +0,0 @@ -# 501 Not Implemented - -The HTTP code 501 indicates that the server has not implemented this service at -this path and for this method. - -For more information see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/501](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/501) diff --git a/api/default/error-501/error-nnn.tmpl b/api/default/error-501/error-nnn.tmpl deleted file mode 100644 index ddb131a..0000000 --- a/api/default/error-501/error-nnn.tmpl +++ /dev/null @@ -1,10 +0,0 @@ -{ - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-model" - } - } - }, - "description": "The service is not implemented" -} \ No newline at end of file diff --git a/api/default/error-503.json b/api/default/error-503.json index f4e93b8..f1d9c34 100644 --- a/api/default/error-503.json +++ b/api/default/error-503.json @@ -1,12 +1,12 @@ { "name": "error-503", - "guide": "{{.SelfFolder}}/error-503.md", + "guide": "{{.SelfFolder}}/error-5nn.md", "description": "503 error response", "templates": [ { "engine": "", - "folder": "{{.SelfFolder}}/{{.TemplateName}", - "file_name": "error-nnn.tmpl", + "folder": "{{.SelfFolder}}/error-nnn", + "file_name": "error-503.json", "output_folder": "", "output_name": "", "section": "", diff --git a/api/default/error-503.md b/api/default/error-503.md deleted file mode 100644 index f05f49b..0000000 --- a/api/default/error-503.md +++ /dev/null @@ -1,6 +0,0 @@ -# 503 Service Unavailable - -The HTTP code 503 indicates that the server is not ready to handle the request. This could be a temporary -or longer term issue. - -For more information see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/503) diff --git a/api/default/error-503/error-nnn.tmpl b/api/default/error-503/error-nnn.tmpl deleted file mode 100644 index 7788426..0000000 --- a/api/default/error-503/error-nnn.tmpl +++ /dev/null @@ -1,10 +0,0 @@ -{ - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-model" - } - } - }, - "description": "The service is unavailable" -} \ No newline at end of file diff --git a/api/default/error-5nn.md b/api/default/error-5nn.md new file mode 100644 index 0000000..59278d5 --- /dev/null +++ b/api/default/error-5nn.md @@ -0,0 +1,22 @@ +# 5nn Server errors + +## 500 Not Implemented + +The HTTP code 501 indicates that the server encountered an unexpected +condition that prevented it from fulfilling the request. + +For more information see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/501](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/500) + +## 501 Not Implemented + +The HTTP code 501 indicates that the server has not implemented this service at +this path and for this method. + +For more information see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/501](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/501) + +## 503 Service Unavailable + +The HTTP code 503 indicates that the server is not ready to handle the request. This could be a temporary +or longer term issue. + +For more information see [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/503) diff --git a/api/default/error-nnn/error-400.json b/api/default/error-nnn/error-400.json new file mode 100644 index 0000000..0312c35 --- /dev/null +++ b/api/default/error-nnn/error-400.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "The server could not understand the request due to incorrect syntax. The client should NOT repeat the request without modifications." +} \ No newline at end of file diff --git a/api/default/error-nnn/error-401.json b/api/default/error-nnn/error-401.json new file mode 100644 index 0000000..8338dfd --- /dev/null +++ b/api/default/error-nnn/error-401.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "Indicates that the request requires user authentication information. The client MAY repeat the request with a suitable Authorization header field" +} \ No newline at end of file diff --git a/api/default/error-nnn/error-403.json b/api/default/error-nnn/error-403.json new file mode 100644 index 0000000..8f29145 --- /dev/null +++ b/api/default/error-nnn/error-403.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "Unauthorized request. The client does not have access rights to the content. Unlike 401, the client’s identity is known to the server." +} \ No newline at end of file diff --git a/api/default/error-nnn/error-404.json b/api/default/error-nnn/error-404.json new file mode 100644 index 0000000..5240757 --- /dev/null +++ b/api/default/error-nnn/error-404.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "The server can not find the requested resource." +} \ No newline at end of file diff --git a/api/default/error-nnn/error-405.json b/api/default/error-nnn/error-405.json new file mode 100644 index 0000000..dfb3191 --- /dev/null +++ b/api/default/error-nnn/error-405.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "The server knows the request HTTP method, but it has been disabled and cannot be used for that resource." +} \ No newline at end of file diff --git a/api/default/error-nnn/error-410.json b/api/default/error-nnn/error-410.json new file mode 100644 index 0000000..cb675d1 --- /dev/null +++ b/api/default/error-nnn/error-410.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "The requested resource is no longer available on the server." +} \ No newline at end of file diff --git a/api/default/error-nnn/error-4nn.json b/api/default/error-nnn/error-4nn.json new file mode 100644 index 0000000..e61295a --- /dev/null +++ b/api/default/error-nnn/error-4nn.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "Client error" +} \ No newline at end of file diff --git a/api/default/error-nnn/error-500.json b/api/default/error-nnn/error-500.json new file mode 100644 index 0000000..c9a5d11 --- /dev/null +++ b/api/default/error-nnn/error-500.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "The server encountered an unexpected condition that prevented it from fulfilling the request." +} \ No newline at end of file diff --git a/api/default/error-nnn/error-501.json b/api/default/error-nnn/error-501.json new file mode 100644 index 0000000..f41d100 --- /dev/null +++ b/api/default/error-nnn/error-501.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "The HTTP method is not supported by the server and cannot be handled." +} \ No newline at end of file diff --git a/api/default/error-nnn/error-503.json b/api/default/error-nnn/error-503.json new file mode 100644 index 0000000..508a5ca --- /dev/null +++ b/api/default/error-nnn/error-503.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "The server is not ready to handle the request." +} \ No newline at end of file diff --git a/api/default/error-nnn/error-5nn.json b/api/default/error-nnn/error-5nn.json new file mode 100644 index 0000000..9c6b0f7 --- /dev/null +++ b/api/default/error-nnn/error-5nn.json @@ -0,0 +1,10 @@ +{ + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-model" + } + } + }, + "description": "Server error" +} \ No newline at end of file