From 61a30d109c08e05c5fc403d6f9822afe794f25f2 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Mon, 26 Feb 2024 18:14:31 +0100 Subject: [PATCH] Update API-design-guidelines.md --- documentation/API-design-guidelines.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index b65b2295..e3225a03 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1034,7 +1034,8 @@ This part must include the following information: - Schemes supported (HTTP, HTTPS…) - Allowed response formats (“application/json”, “text/xml”…) - Response format (“application/jwt”…) - +- Global `tags` object if tags are used for API operations +

@@ -1046,7 +1047,7 @@ This part must contain the list of published functions, with the following descr - HTTP Methods. For each one, the following shall be included: - Functionality summary. - Functionality method description. - - Tag list to classify methods. + - Optionally `tags` object for each API operation - Title Case is the recommended style for tag names. - Request param list, making reference to "Request params" part. - Supported responses list, describing success and errors cases.