Fix incorrect error code and reference link for UNAUTHORIZED error

[Vardhaman619]

What does this PR do?

This PR fixes the incorrect error code and reference link in the example for the UNAUTHORIZED error code within the documentation. The example previously displayed INTERNAL_SERVER_ERROR as the code and its corresponding documentation link. These have now been corrected to reflect the proper UNAUTHORIZED error code and the correct documentation link.

Fixes #2226

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

1. Verify that the UNAUTHORIZED error code is now displayed correctly in Docs -> API Reference -> Errors -> UNAUTHORIZED.
2. Ensure the documentation link provided for the UNAUTHORIZED error code now points to the correct reference.

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

• Documentation
  • Updated the openapi-schema value for the UNAUTHORIZED error to reflect a more accurate categorization of authorization failures.

[changeset-bot]

⚠️ No Changeset found

Latest commit: e79bb4e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 6, 2024 10:11am

[vercel]

@Vardhaman619 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request involve updating the openapi-schema value for the UNAUTHORIZED error in the documentation. The previous value, ErrInternalServerError, has been replaced with ErrUnauthorized. This adjustment clarifies the categorization of the error, ensuring it accurately reflects authorization failures.

Changes

Files	Change Summary
apps/docs/api-reference/errors/code/UNAUTHORIZED.mdx	Updated openapi-schema from ErrInternalServerError to ErrUnauthorized

Assessment against linked issues

Objective	Addressed	Explanation
Correct the error code in documentation (Issue #2226)	✅

Possibly related PRs

• docs: correct spelling of EXPRED to EXPIRED #2228: The changes in this PR involve correcting a spelling error in the documentation for the EXPIRED error, which is related to error categorization similar to the changes made in the UNAUTHORIZED error documentation in the main PR.

Suggested labels

Bug, Documentation, 🕹️ oss.gg, :joystick: 150 points, hacktoberfest

Suggested reviewers

• perkinsjr
• chronark

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 07d5b86 and e79bb4e.

📒 Files selected for processing (1)

• apps/docs/api-reference/errors/code/UNAUTHORIZED.mdx (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

apps/docs/api-reference/errors/code/UNAUTHORIZED.mdx (1)

3-3: LGTM! The error code has been correctly updated.

The change from ErrInternalServerError to ErrUnauthorized in the openapi-schema field accurately reflects the nature of the UNAUTHORIZED error. This update aligns perfectly with the PR objectives and resolves the documentation inconsistency mentioned in issue #2226.

The rest of the document, including the problem description and solution, already correctly describes an authorization failure, so no further changes were necessary.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.
Here is an example:

<type>[optional scope]: <description>
fix: I fixed something for Unkey

Details:

No release type found in pull request title "Fix incorrect error code and reference link for UNAUTHORIZED error". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

[oss-gg]

Awarding Vardhaman619: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/Vardhaman619