feat:Add x-required-api-key-type extension to three Vectara REST API v2 endpoints

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Updated API documentation to clearly indicate the required API key types for specific endpoints, improving transparency around authorization requirements.

[coderabbitai]

Walkthrough

The OpenAPI specification for the Vectara REST API v2 was updated to include the x-required-api-key-type extension in three endpoints. This extension documents the required API key types for authorization on the Create Corpus, List Corpora, and Replace Document Metadata operations. No other API structure or schema changes were made.

Changes

File(s)	Change Summary
src/libs/Vectara/openapi.yaml	Added x-required-api-key-type metadata to three endpoints to specify required API key types

Estimated code review effort

1 (~2 minutes)

Poem

Three endpoints now declare their key,
With types required for all to see.
The OpenAPI grows precise,
Security rules, clear and nice.
A rabbit hops through docs anew,
Approving changes—quickly too!
🐇✨

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch bot/update-openapi_202507211837

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/libs/Vectara/openapi.yaml (2)

316-318: Consistent ordering / deduplication of key-types.

Double-check that "QueryService" and "Personal" accurately reflect the backend authorization policy for GET /v2/corpora, and that no additional key types (e.g. IndexService) are required. If policies change frequently, consider deriving this list from the source-of-truth policy file during the SDK build rather than hard-coding it here.

---

1069-1071: Consider unifying the extension name / semantics with existing security schemes.

The spec already defines security: blocks that reference API-key schemes. Introducing a parallel x-required-api-key-type risks divergence. If feasible, encode the requirement with standard OpenAPI constructs (multiple named API-key schemes in security:) and keep the vendor extension only as supplementary documentation.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 112f890 and bde88f3.

📒 Files selected for processing (1)

• src/libs/Vectara/openapi.yaml (3 hunks)

🔇 Additional comments (1)

src/libs/Vectara/openapi.yaml (1)

263-264: x-required-api-key-type is correctly aligned at the operation level

The x-required-api-key-type block sits at the same indentation as responses, operationId, and the other x-fern-* extensions under the post operation—so it won’t be treated as part of a response object. No changes are needed.