Skip to content

Shorten WIF entries in CHANGELOG.md to match house style - #1897

Merged
bcantoni merged 2 commits into
tableau:developmentfrom
sushmasreedharan-tableau:dev/sreedharan/changelog-shorten-wif-entries
Oct 27, 2026
Merged

bcantoni merged 2 commits into
tableau:developmentfrom
sushmasreedharan-tableau:dev/sreedharan/changelog-shorten-wif-entries

Conversation

@sushmasreedharan-tableau

Copy link
Copy Markdown
Contributor

Summary

Review comment on #1887 and #1894: the WIF entries I added to CHANGELOG.md ran ~34 and ~56 lines, while every other entry in the file is 2–9 lines. Shortening both to ~13 lines each so they match the shape of the surrounding entries (urllib3 bump, redirect preservation, CSVImport fix).

What I kept:

  • Headline capability + three new exports (admin API entry).
  • Headline capability + the two mode values + impersonation-only service-account constraint (connection update entry).
  • Server version floor and auth / role requirements.
  • The gotchas a caller must know: non-UUID targets rejected client-side; resend workgroup_auth_mode on later updates.

What I dropped:

  • Per-method breakdown of all 12 server.auth_federation.* endpoints — covered by the API docs on gh-pages (PR @W-24145098 - docs: document WIF admin REST API endpoints #1895).
  • Key-rotation recipe and NO_ACCESS scope note — same reason, docs cover it.
  • Full enumerate-every-endpoint signature for the connection update methods.

Net: +20 / -82.

🤖 Generated with Claude Code

The two WIF entries added by tableau#1887 and tableau#1894 were ~34 and ~56 lines;
every other entry in the file is 2-9 lines. Compressed both to ~13
lines each, keeping the headline capability, the key constraints
(server version, auth, side-effects), and the gotchas callers must
know (reject non-UUID; resend `workgroup_auth_mode`); moved the full
method-by-method surface area to the API docs on gh-pages where it
belongs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Entry 2: restore the "server does not echo WIF attributes on GET
  today" caveat. Without it a round-trip write-then-read silently
  returns None, with no error signal to tell the caller why.
- Entry 1: distinguish "WIF feature not available on the site" (403
  across the board) from "admin has not yet called enable()"
  (config/connector operations return 404; get() returns a shell).
  Prior wording collapsed both into "WIF is not enabled" which
  conflicts with the enable() method name.
- Entry 1: restore the NO_ACCESS caveat for key-management methods
  (connected-app JWT sessions return 401; use a PAT or password
  session for key rotation).
- Standardize "available / enabled" wording across both entries.

Entries now land at 14 lines each — still within the house range
(urllib3 / redirects / CSVImport neighbors run 6–9 lines).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@bcantoni
bcantoni merged commit 782c0dc into tableau:development Oct 27, 2026
30 of 31 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