From 9734e2762593d0e7ee74747015744c05c4672d9b Mon Sep 17 00:00:00 2001 From: drew Date: Mon, 13 Nov 2023 22:30:09 -0500 Subject: [PATCH 1/2] Specify content type changes as breaking in the API --- doc/development/api_styleguide.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md index 714115d474af47..d5a4cb54ccbddd 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -93,10 +93,11 @@ Even in this exception, rather than removing a field or argument, we must always Some examples of breaking changes are: -- Removing or renaming fields, arguments, or enum values. +- Removing or renaming fields, arguments, or enum values. In a JSON response, a field is any JSON key. - Removing endpoints. - Adding new redirects (not all clients follow redirects). -- Changing the type of fields in the response (for example, from `String` to `Integer`). +- Changing the content type of any response. +- Changing the type of fields in the response (for example, from `String` to `Integer`). In a JSON response, a field is any JSON key and value. - Adding a new **required** argument. - Changing authentication, authorization, or other header requirements. - Changing [any status code](../api/rest/index.md#status-codes) other than `500`. -- GitLab From 3c070109c325b1fb05513c52c73b9aa7bc62b2fe Mon Sep 17 00:00:00 2001 From: Luke Duncalfe Date: Fri, 16 Feb 2024 00:34:34 +0000 Subject: [PATCH 2/2] Apply 1 suggestion(s) to 1 file(s) --- doc/development/api_styleguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md index d5a4cb54ccbddd..6ccf075fecd387 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -97,7 +97,7 @@ Some examples of breaking changes are: - Removing endpoints. - Adding new redirects (not all clients follow redirects). - Changing the content type of any response. -- Changing the type of fields in the response (for example, from `String` to `Integer`). In a JSON response, a field is any JSON key and value. +- Changing the type of fields in the response. In a JSON response, this would be a change of any `Number`, `String`, `Boolean`, `Array`, or `Object` type to another type. - Adding a new **required** argument. - Changing authentication, authorization, or other header requirements. - Changing [any status code](../api/rest/index.md#status-codes) other than `500`. -- GitLab