docs: add bearer authentication to schema

[eynopv]

Summary by CodeRabbit

• New Features
  • Expanded authentication support to include both Basic and Bearer methods, offering increased flexibility for API requests.
• Documentation
  • Updated authentication guidelines to clearly outline the required fields for each supported authentication method.

[coderabbitai]

Walkthrough

The JSON schema in docs/json-schemas/request.schema.json was updated to restructure the auth property. Rather than a single authentication method, the schema now supports multiple authentication types using the oneOf keyword. It distinguishes between Basic Authentication (requiring type, username, and password) and Bearer Authentication (requiring type and token), with explicit constraints on the type property.

Changes

File	Change Summary
docs/json-schemas/request.schema.json	Modified the auth property to support multiple authentication methods via oneOf. Now includes two object types: Basic Authentication (with type "basic", username, and password) and Bearer Authentication (with type "bearer" and token).

---

🪧 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/json-schemas/request.schema.json (1)

8-44: Optional: Consider Adding a Discriminator
Since the schema now distinguishes between authentication types using the "oneOf" array, you might consider using the JSON Schema discriminator property (supported in draft 2020-12) based on the "type" field. This can improve error messages and validation clarity when multiple schemas are merged.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4ec376b and 78a0828.

📒 Files selected for processing (1)

• docs/json-schemas/request.schema.json (1 hunks)

🔇 Additional comments (3)

docs/json-schemas/request.schema.json (3)

9-10: Enhanced Auth Property with Multiple Methods
The updated "auth" property now leverages the oneOf keyword to support both Basic and Bearer authentication. This enhances flexibility by allowing multiple authentication types within the same schema. Make sure that all consuming clients or tools validate this new structure correctly.

---

11-28: Basic Authentication Schema Validation
The Basic authentication schema is clearly defined with "type": "object", a proper description, and required properties ("type", "username", and "password"). Constraining "type" via "const": "basic" is a good approach to ensure that only the intended value is permitted.

---

29-42: Bearer Authentication Schema Validation
The Bearer authentication object is well specified. It correctly restricts "type" to "bearer" and requires the "token" property, ensuring clear differentiation from Basic authentication. This change directly meets the PR objective of adding bearer authentication support.