-
Notifications
You must be signed in to change notification settings - Fork 307
Fix POST query endpoint request body property names in Enterprise API… #6247
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
Fix POST query endpoint request body property names in Enterprise API… #6247
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ref.yml
looks good. Can you restore helper-scripts/common/config/influxdb3-core-enterprise.json
(or only commit ref.yml) and update the PR branch--for example:
git checkout -t origin/fix/api-enterprise-docs-query-sql-field-names
git reset origin/master
git add api-docs
git commit -C 6b7ca8b
git push -f origin fix/api-enterprise-docs-query-sql-field-names
58ed29d
to
80cb646
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the InfluxDB Enterprise API specification to align POST endpoint request body property names with the corresponding GET endpoint parameters. The change ensures consistency between the /api/v3/query_sql
POST and GET endpoints by standardizing on shorter parameter names.
Key Changes
- Updated QueryRequestObject schema property names from
database
todb
andquery_str
toq
- Updated all references and examples to use the new consistent naming
type: string | ||
query_str: | ||
q: | ||
description: The query to execute. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This API change modifies the request body property names from 'database' to 'db' and 'query_str' to 'q'. This is a breaking change that will affect existing API consumers who are using the POST endpoint with the old property names. Consider documenting this as a breaking change and providing migration guidance.
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
… spec
fix: align POST /api/v3/query_sql property names with GET params in Enterprise
Update QueryRequestObject schema to use 'db' and 'q' instead of
'database' and 'query_str' for consistency with GET endpoint.
Closes #6223