Skip to content

Fix v1 auth monolith documentation and tooling #6194

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 8 commits into
base: master
Choose a base branch
from

Conversation

jstirnaman
Copy link
Contributor

@jstirnaman jstirnaman commented Jul 8, 2025

Summary

  • Fix curl --user syntax in API documentation examples
  • Update codeblock formatting for consistency
  • Remove shared code samples to reduce duplication
  • Fix curl -u syntax in serverless documentation
  • Update influxdb3 paths in test configurations
  • Add Claude commands for release notes enhancement and GitHub issue fixing
  • Add context directory structure for LLM interactions
  • Update copilot instructions with abbreviations and shortcuts

Test plan

  • Verify curl authentication examples work correctly
  • Check that codeblock formatting renders properly
  • Confirm influxdb3 path updates are correct
  • Test new Claude commands functionality
  • Validate documentation structure changes

🤖 Generated with Claude Code

@jstirnaman jstirnaman requested review from sanderson and Copilot July 8, 2025 05:54
Copy link
Contributor

@Copilot Copilot AI left a 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 authentication examples for v1 compatibility across docs, consolidates shared snippets into inline code blocks, and adjusts tooling configuration paths for InfluxDB 3.

  • Fixes curl --user syntax and query-string auth in documentation
  • Removes shared script snippets and embeds inline examples
  • Updates Hugo healthchecks and test mounts to influxdb3 paths
  • Enhances OpenAPI specs with new security schemes and parameter definitions

Reviewed Changes

Copilot reviewed 29 out of 29 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
shared/text/api/cloud-dedicated/querystring-auth.sh Removed obsolete shared query-string auth snippet
shared/text/api/cloud-dedicated/basic-auth.sh Removed obsolete shared basic-auth snippet
content/shared/.../compatibility-apis.md Added v1/v2 token auth sections and examples inline
content/.../influxdb-v1-api.md Updated query examples to use --user "any:TOKEN"
compose.yaml Adjusted healthcheck URL and CONTENT_PATH to influxdb3
api-docs/**/v3/ref.yml Introduced BasicAuthentication, TokenAuthentication, and QuerystringAuthentication schemes
Comments suppressed due to low confidence (2)

content/influxdb3/cloud-dedicated/write-data/_index.md:26

  • [nitpick] Use a shell-specific code block (e.g., sh or bash) instead of ```http for shell/cURL examples to improve syntax highlighting.
> When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).

api-docs/influxdb3/enterprise/v3/ref.yml:42

  • Verify that the security scheme key BearerAuthentication matches the component definition and that all references to the old BearerAuth key have been updated accordingly to avoid broken links in the spec.
  - BearerAuthentication: []

description: |
Password for v1 compatibility authentication.
For query string authentication, pass an admin token.
InfluxDB 3 checks that the `p` value is an auhtorized token.
Copy link
Preview

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

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

Correct the spelling of "auhtorized" to "authorized" in the v1PasswordParam description.

Suggested change
InfluxDB 3 checks that the `p` value is an auhtorized token.
InfluxDB 3 checks that the `p` value is an authorized token.

Copilot uses AI. Check for mistakes.

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.

1 participant