From a8e2e0a47bde939b461c693de069d3dbf37ab4eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hazel=20Vird=C3=B3?= Date: Tue, 15 Oct 2024 17:16:40 -0400 Subject: [PATCH] Make the descriptions of responses grammatically consistent --- specification/shared/responses/accepted.yml | 2 +- specification/shared/responses/bad_request.yml | 4 ++-- specification/shared/responses/conflict.yml | 2 +- specification/shared/responses/server_error.yml | 2 +- specification/shared/responses/too_many_requests.yml | 4 ++-- specification/shared/responses/unauthorized.yml | 2 +- specification/shared/responses/unexpected_error.yml | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/shared/responses/accepted.yml b/specification/shared/responses/accepted.yml index 95257305..23e8123b 100644 --- a/specification/shared/responses/accepted.yml +++ b/specification/shared/responses/accepted.yml @@ -1,4 +1,4 @@ -description: The does not indicate the success or failure of any +description: This does not indicate the success or failure of any operation, just that the request has been accepted for processing. headers: diff --git a/specification/shared/responses/bad_request.yml b/specification/shared/responses/bad_request.yml index 544c5a12..55398341 100644 --- a/specification/shared/responses/bad_request.yml +++ b/specification/shared/responses/bad_request.yml @@ -1,4 +1,4 @@ -description: Bad Request +description: There was an error parsing the request body. headers: ratelimit-limit: @@ -15,4 +15,4 @@ content: example: id: bad_request message: error parsing request body - request_id: 4851a473-1621-42ea-b2f9-5071c0ea8414 \ No newline at end of file + request_id: 4851a473-1621-42ea-b2f9-5071c0ea8414 diff --git a/specification/shared/responses/conflict.yml b/specification/shared/responses/conflict.yml index f2478b65..7a693e77 100644 --- a/specification/shared/responses/conflict.yml +++ b/specification/shared/responses/conflict.yml @@ -1,4 +1,4 @@ -description: Conflict +description: The request could not be completed due to a conflict. headers: ratelimit-limit: diff --git a/specification/shared/responses/server_error.yml b/specification/shared/responses/server_error.yml index 24ca9e97..064b4fb5 100644 --- a/specification/shared/responses/server_error.yml +++ b/specification/shared/responses/server_error.yml @@ -1,4 +1,4 @@ -description: Server error. +description: There was a server error. headers: ratelimit-limit: diff --git a/specification/shared/responses/too_many_requests.yml b/specification/shared/responses/too_many_requests.yml index 21dca433..59324487 100644 --- a/specification/shared/responses/too_many_requests.yml +++ b/specification/shared/responses/too_many_requests.yml @@ -1,4 +1,4 @@ -description: API Rate limit exceeded +description: The API rate limit has been exceeded. headers: ratelimit-limit: @@ -14,4 +14,4 @@ content: $ref: '../models/error.yml' example: id: too_many_requests - message: API Rate limit exceeded. + message: API rate limit exceeded. diff --git a/specification/shared/responses/unauthorized.yml b/specification/shared/responses/unauthorized.yml index 50ccec55..e6083aee 100644 --- a/specification/shared/responses/unauthorized.yml +++ b/specification/shared/responses/unauthorized.yml @@ -1,4 +1,4 @@ -description: Unauthorized +description: Authentication failed due to invalid credentials. headers: ratelimit-limit: diff --git a/specification/shared/responses/unexpected_error.yml b/specification/shared/responses/unexpected_error.yml index 20d15dab..c922d0ee 100644 --- a/specification/shared/responses/unexpected_error.yml +++ b/specification/shared/responses/unexpected_error.yml @@ -1,4 +1,4 @@ -description: Unexpected error +description: There was an unexpected error. headers: ratelimit-limit: