Skip to content

docs(savanna): use the same API key auth on org user pages - #178

Merged
Tushar-TG-14 merged 4 commits into
tigergraph:mainfrom
ngarakapati:fix/org-user-authorizations
Sep 28, 2026
Merged

Tushar-TG-14 merged 4 commits into
tigergraph:mainfrom
ngarakapati:fix/org-user-authorizations

Conversation

@ngarakapati

@ngarakapati ngarakapati commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • List org users and Update an org user's role now use the same Authorizations section as every other endpoint: required x-api-key header and the Create an API key link.
  • Request samples send x-api-key as well. The overview no longer says these calls reject API keys.
  • The source catalogs now explicitly declare ApiKeyAuth for both operations and no longer describe them as API-key incompatible, preventing regeneration from restoring the stale note.

Merge order

Merge #177 first, then this pull request. This branch is based on that one so the generator changes do not conflict.

Test plan

  • Run npm run endpoints:split -- --check.
  • Confirm no does not support API key or not APIKEY compatible text remains in the Savanna REST API source.
  • Confirm the changed files have no lint errors.
  • After fix(savanna): resolve Create API key links through Antora xrefs #177 is merged, open List org users and Update an org user's role in the deploy preview.
  • Confirm Authorizations matches another endpoint, such as Check the current IP: x-api-key, required, and a Create an API key link.
  • Confirm the request samples send x-api-key.

The full local Antora build still reports existing Cloud-doc issues (invoices reference and missing clusterdomain attribute), unrelated to these changes.

Hand-written .html hrefs were rewritten to site-root paths that drop /docs and 404.
These calls reject API keys. The pages now show the Authorization header they require.
@netlify

netlify Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for thriving-strudel-91d4a9 ready!

Name Link
🔨 Latest commit b6c9f82
🔍 Latest deploy log https://app.netlify.com/projects/thriving-strudel-91d4a9/deploys/6aba586bc5635c0008e8926f
😎 Deploy Preview https://deploy-preview-178--thriving-strudel-91d4a9.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

These endpoints now show the same x-api-key Authorizations block as the rest of the reference.
@ngarakapati ngarakapati changed the title docs(savanna): document ID token auth on org user endpoints docs(savanna): use the same API key auth on org user pages Sep 27, 2026
@Tushar-TG-14
Tushar-TG-14 merged commit 0966fb6 into tigergraph:main Sep 28, 2026
4 of 5 checks passed
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.

2 participants