Skip to content

Add Version 2 request support to Natural Language API documentation #130

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

rakeshkky
Copy link
Member

Description 📝

This PR enhances the Natural Language API documentation by adding comprehensive support for Version 2 (v2) requests alongside the existing Version 1 (v1) documentation.

Key changes:

  • Added complete v2 request documentation with build-based configuration
  • Clarified authentication requirements for both versions (Bearer token vs deprecated API key field)
  • Documented PromptQL configuration resolution order for v2 (build-level config with project-level fallback)
  • Enhanced DDN authentication section to cover both v1 and v2 implementations
  • Improved overall structure and organization of the API documentation
  • The updates provide clear guidance for developers migrating to v2 while maintaining backward compatibility documentation for v1 users.

Quick Links 🚀

Assertion Tests 🤖

@hasura-bot hasura-bot requested a review from seanparkross June 4, 2025 08:45
@hasura-bot
Copy link
Collaborator

@rakeshkky Thanks for your PR! I've assigned @seanparkross to review it.

Copy link

cloudflare-workers-and-pages bot commented Jun 4, 2025

Deploying promptql-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9196da6
Status: ✅  Deploy successful!
Preview URL: https://e597eca2.promptql-docs.pages.dev
Branch Preview URL: https://rakeshkky-promptql-api-v2-do.promptql-docs.pages.dev

View logs

@rakeshkky rakeshkky added the ready-for-review PR is ready for review label Jun 4, 2025
Copy link
Contributor

@seanparkross seanparkross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. A few questions / suggestions

- **Version 1 (v1)**: Uses direct DDN URL configuration with optional LLM settings
- **Version 2 (v2)**: Uses DDN build-based configuration with settings from build metadata

### Request v1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we put v1 and v2 in tabs? Is it a case of it's normally one or the other or will a user ever use both versions together? I can set up the tabs if yes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-for-review PR is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants