Skip to content

api-docs: tags.yml links to a QuerystringAuthentication anchor that no longer exists in the v2 and Cloud specs #7667

Description

@jstirnaman

api-docs/influxdb/v2/tags.yml:9 and api-docs/influxdb/cloud/tags.yml:9 both contain:

- [Querystring authentication](#section/Authentication/QuerystringAuthentication)

That anchor is generated from components.securitySchemes. Current upstream contracts/ref/oss.yml on influxdata/openapi docs-release/influxdb-oss declares only BasicAuthentication and TokenAuthentication — no QuerystringAuthentication. So the link has no target.

Verification

Running the pipeline against current sources:

cd api-docs && bash getswagger.sh v2
cd .. && node api-docs/scripts/dist/post-process-specs.js

python3 -c "import yaml;print(sorted(yaml.safe_load(open('api-docs/_build/influxdb/v2/influxdb-oss-v2-openapi.yaml'))['components']['securitySchemes']))"
# ['BasicAuthentication', 'TokenAuthentication']

grep -n QuerystringAuthentication api-docs/_build/influxdb/v2/influxdb-oss-v2-openapi.yaml
# 76:      - [Querystring authentication](#section/Authentication/QuerystringAuthentication)

One occurrence in the built spec — the tags.yml link itself, with nothing to point at.

Why the currently-committed spec hides this

api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml still carries a QuerystringAuthentication entry under components.securitySchemes, left over from an older upstream contract. But even there it has zero $refs and is absent from the top-level security: block, so it's already an orphan definition. Whether the rendered page currently produces a working anchor from an unreferenced scheme is worth checking; either way, the next regeneration removes the definition and the link definitely breaks.

Note this is unrelated to #7175, which is about per-tag page URLs not resolving in the built site.

Fix options

  1. Drop the bullet from both tags.yml files, if querystring auth is genuinely no longer supported for these APIs.
  2. Restore QuerystringAuthentication upstream in influxdata/openapi if the v1-compatibility endpoints still accept ?u=&p=, and keep the link.

Option 2 needs a product answer — the v1-compat /query and /write operations in the OSS v2 spec do still document inline u and p query parameters, which suggests the auth method exists but is no longer declared as a security scheme.

The InfluxDB 3 specs (core, enterprise, clustered, cloud-dedicated, cloud) all still define QuerystringAuthentication and reference it from security:, so this only affects the v2 and Cloud v2 specs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions