Skip to content

Tag every outbound stdapi.ai link this repo and the Terraform module control #204

Description

@JGoutin

Links out to stdapi.ai from this repo and from terraform-aws-stdapi-ai are untagged, so clicks from them cannot be told apart from any other traffic. Add UTM parameters to the ones a human clicks.

A tagged URL is safe for search: /models/?utm_source=... still serves <link rel="canonical" href="https://stdapi.ai/models/">.

Values

Surface utm_source utm_medium utm_campaign
Gateway docs surface api-docs product owned-surfaces
stdapi.ai README github-readme repo owned-surfaces
terraform-aws-stdapi-ai README terraform-readme repo owned-surfaces

This repo

stdapi/main.py:417contact={"name": "stdapi.ai", "url": "https://stdapi.ai"}. Swagger UI renders this as the clickable link in the /docs header. Tag it.

stdapi/routes/core_root.py:34_API_REFERENCE_URL serves two different jobs and must be split before either can be tagged:

  • core_root.py:42, in _WELCOME, is human-facing: the fallback shown at / when both /docs and /redoc are disabled. Tag it.
  • core_root.py:67, "resource_documentation", is RFC 9728 OAuth protected resource metadata. Machine-parsed, must stay clean.

stdapi/metering.py:23 — OpenAPI license.url. Leave untagged; licence tooling reads this field.

README.md — the prose links to stdapi.ai (lines 97, 133, 155, 172, 246, 259, and the feature and use-case tables).

terraform-aws-stdapi-ai

Same treatment for its README.md: the prose links, including the documentation table at lines 174 to 184 and lines 8, 67, 71, 75, 168.

That repo releases on its own cycle, so it needs either its own issue or a note here about which release carries it.

Do not tag

  • <img src> URLs (this README lines 26 and 197, the module README line 190). An image request is not a page view.
  • Any URL inside a fenced code block or a configuration example, and above all a base URL a reader pastes into a client.
  • Machine-parsed metadata: license.url, resource_documentation.
  • Domains that are not stdapi.ai, such as the AWS Marketplace links.

Done when

  • _API_REFERENCE_URL split, only the human-facing constant tagged
  • contact.url tagged; license.url and resource_documentation still clean
  • Both READMEs tagged, image src and code blocks untouched
  • A tagged URL from each surface returns 200 with its query string intact, and still serves a query-free canonical

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    • Status
      Backlog

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions