Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat:Update openapi.yaml file in src/libs/Cohere directory #120

Merged
merged 1 commit into from
Nov 29, 2024
Merged

feat:Update openapi.yaml file in src/libs/Cohere directory #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 19 additions & 55 deletions src/libs/Cohere/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1457,11 +1457,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning description for incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
content:
application/json:
schema:
Expand Down Expand Up @@ -1643,11 +1639,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning description for incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
content:
application/json:
schema:
Expand Down Expand Up @@ -4911,11 +4903,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning description for incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
content:
application/json:
schema:
Expand Down Expand Up @@ -8125,11 +8113,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning description for incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
content:
application/json:
schema:
Expand Down Expand Up @@ -8195,11 +8179,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning description for incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
content:
application/json:
schema:
Expand Down Expand Up @@ -8274,11 +8254,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning message for potentially incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
content:
application/json:
schema:
Expand Down Expand Up @@ -8353,11 +8329,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning description for incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
'400':
$ref: '#/components/responses/BadRequest'
'401':
Expand Down Expand Up @@ -9623,11 +9595,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning description for incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
content:
application/json:
schema:
Expand Down Expand Up @@ -9746,11 +9714,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning description for incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
content:
application/json:
schema:
Expand Down Expand Up @@ -9914,11 +9878,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning description for incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
content:
application/json:
schema:
Expand Down Expand Up @@ -10467,11 +10427,7 @@ paths:
description: OK
headers:
X-API-Warning:
description: Warning description for incorrect usage of the API
schema:
type: string
x-fern-audiences:
- public
$ref: '#/components/headers/ApiWarning'
content:
application/json:
schema:
Expand Down Expand Up @@ -16857,6 +16813,14 @@ components:
example: my-cool-project
x-fern-audiences:
- public
headers:
ApiWarning:
description: The name of the project that is making the request.
schema:
type: string
example: 'Parameter xyz is deprecated, for more information please refer to https://docs.cohere.com/versioning-reference'
x-fern-audiences:
- public
Comment on lines +16816 to +16823
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Header component definition looks good with a minor suggestion

The ApiWarning header component is well-defined with proper documentation and example. However, the description seems to be copied from a different header as it mentions "project name" which doesn't match the purpose of this warning header.

Consider updating the description to better reflect the purpose of the warning header:

    ApiWarning:
-     description: The name of the project that is making the request.
+     description: Contains warning messages about API usage, such as deprecation notices.
      schema:
        type: string
      example: 'Parameter xyz is deprecated, for more information please refer to https://docs.cohere.com/versioning-reference'
      x-fern-audiences:
        - public
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
headers:
ApiWarning:
description: The name of the project that is making the request.
schema:
type: string
example: 'Parameter xyz is deprecated, for more information please refer to https://docs.cohere.com/versioning-reference'
x-fern-audiences:
- public
headers:
ApiWarning:
description: Contains warning messages about API usage, such as deprecation notices.
schema:
type: string
example: 'Parameter xyz is deprecated, for more information please refer to https://docs.cohere.com/versioning-reference'
x-fern-audiences:
- public

securitySchemes:
bearerAuth:
type: http
Expand Down
Loading