Skip to content

Commit

Permalink
fix(cli): improve generated error names in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dsinghvi committed Feb 3, 2025
1 parent bcb2a9f commit f36711c
Show file tree
Hide file tree
Showing 29 changed files with 57,004 additions and 134,794 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,12 @@
"absoluteFilepath": "/DUMMY_PATH",
"contents": {
"errors": {
"GetTokenRequestUnauthorizedError": {
"docs": "Unauthorized",
"status-code": 401,
"type": "unknown",
},
"GetUsersRequestNotFoundError": {
"NotFoundError": {
"docs": "User not found",
"status-code": 404,
"type": "unknown",
},
"GetUsersRequestUnauthorizedError": {
"docs": "Unauthorized",
"status-code": 401,
"type": "unknown",
},
"GetUsersUserIdRequestNotFoundError": {
"docs": "User not found",
"status-code": 404,
"type": "unknown",
},
"GetUsersUserIdRequestUnauthorizedError": {
"UnauthorizedError": {
"docs": "Unauthorized",
"status-code": 401,
"type": "unknown",
Expand All @@ -41,7 +26,7 @@
"display-name": "Get authentication token",
"docs": "Retrieve an authentication token for the API",
"errors": [
"GetTokenRequestUnauthorizedError",
"UnauthorizedError",
],
"examples": [
{
Expand Down Expand Up @@ -71,8 +56,8 @@
"display-name": "Get user information",
"docs": "Retrieve detailed information about a specific user",
"errors": [
"GetUsersUserIdRequestUnauthorizedError",
"GetUsersUserIdRequestNotFoundError",
"UnauthorizedError",
"NotFoundError",
],
"examples": [
{
Expand Down Expand Up @@ -109,8 +94,8 @@
"display-name": "List Users",
"docs": "List information about all users",
"errors": [
"GetUsersRequestUnauthorizedError",
"GetUsersRequestNotFoundError",
"UnauthorizedError",
"NotFoundError",
],
"examples": [
{
Expand Down Expand Up @@ -170,26 +155,14 @@
},
},
"rawContents": "errors:
GetUsersRequestUnauthorizedError:
status-code: 401
type: unknown
docs: Unauthorized
GetUsersRequestNotFoundError:
status-code: 404
type: unknown
docs: User not found
GetUsersUserIdRequestUnauthorizedError:
UnauthorizedError:
status-code: 401
type: unknown
docs: Unauthorized
GetUsersUserIdRequestNotFoundError:
NotFoundError:
status-code: 404
type: unknown
docs: User not found
GetTokenRequestUnauthorizedError:
status-code: 401
type: unknown
docs: Unauthorized
service:
auth: false
base-path: ''
Expand All @@ -207,8 +180,8 @@ service:
type: User
status-code: 200
errors:
- GetUsersRequestUnauthorizedError
- GetUsersRequestNotFoundError
- UnauthorizedError
- NotFoundError
examples:
- response:
body:
Expand All @@ -231,8 +204,8 @@ service:
type: User
status-code: 200
errors:
- GetUsersUserIdRequestUnauthorizedError
- GetUsersUserIdRequestNotFoundError
- UnauthorizedError
- NotFoundError
examples:
- path-parameters:
userId: userId
Expand All @@ -255,7 +228,7 @@ service:
type: Token
status-code: 200
errors:
- GetTokenRequestUnauthorizedError
- UnauthorizedError
examples:
- response:
body:
Expand Down
Loading

0 comments on commit f36711c

Please sign in to comment.