Skip to content

chore: Enhance OpenAPI documentation by adding required field formatting and providing a description for the bearerAuth security scheme. #989

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.

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

Merged
merged 1 commit into from
Aug 5, 2025

Conversation

skeptrunedev
Copy link
Contributor

Documentation changes

Adds a link to where to get the API key into the API reference pages for the discovery endpoints of search and assistant.


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

…ing and providing a description for the bearerAuth security scheme.
@cdxker cdxker merged commit dd9c458 into main Aug 5, 2025
5 checks passed
@cdxker cdxker deleted the sk/update-discovery-docs-for-api-key branch August 5, 2025 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants