fix(changetracker): improve API auth UX and move API to top-level sidebar#901
Conversation
…evel sidebar - Change security scheme from apiKey to http/bearer so the interactive explorer labels the token field "Bearer Token" and auto-prepends "Bearer " to the value, eliminating the need for users to know the header format - Move the API section from inside Integrations to a top-level sidebar item (position 115, just below Integrations) for better discoverability - Update all internal links, config paths, gitignore rules, and the parseFrontMatter path check to reflect the new api/ location - Fix inaccurate auth instructions in the API Reference index page to match the actual explorer UI Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
had a problem deploying
to
development
GitHub Actions
Error
Adds orientation for the right-hand panel and clarifies that the Bearer Token is applied automatically, so readers don't expect a separate confirm/apply step. Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
had a problem deploying
to
development
GitHub Actions
Error
Auto-Fix Summary21 issues fixed, 5 skipped across 7 files
| Ask |
…ction
- Remove auto-generated info page ("Introduction"/changetracker-hub)
from sidebar — it duplicates content already shown on every endpoint
page and has a URL slug that doesn't match its label
- Fix "ChangeTracker" → "Change Tracker" in authentication.md,
credentials.md, and register-agents.md (product name style rule)
- Fix "statues" → "statuses" typo and add missing Oxford comma in agents.md
- Fix "wether" → "whether" typo in authentication.md
- Fix broken placeholder URL in agents.md
- Fix misleading attribution in overview.md and reference/index.md —
Docusaurus generates the reference from the spec, not the Hub itself
- Deduplicate sidebar_position values across the API hand-authored pages
Generated with AI
Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
had a problem deploying
to
development
GitHub Actions
Error
Auto-Fix Summary1 issues fixed, 4 skipped across 7 files
| Ask |
…X parse error Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
had a problem deploying
to
development
GitHub Actions
Error
Auto-Fix Summary1 issues fixed, 4 skipped across 7 files
| Ask |
- Add json and powershell language specifiers to code fences in agents.md - Remove stray colon from AgentDisplayNames parameter entry - Fix heading capitalisation: "Json" -> "JSON" - Fix inline code formatting for $NctSession in authentication.md Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
temporarily deployed
to
development
GitHub Actions
Inactive
Auto-Fix Summary0 issues fixed, 5 skipped across 7 files
| Ask |
…mmaries The OpenAPI generator uses summary fields verbatim as page H1 headings and sidebar labels. 348 operation summaries ended with a period, making every generated reference page title read as a sentence fragment with punctuation. Stripped the trailing period from all summary fields in the YAML source. Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
temporarily deployed
to
development
GitHub Actions
Inactive
Auto-Fix Summary0 issues fixed, 4 skipped across 7 files
| Ask |
The Change Tracker Hub API (ASP.NET Web API) exposed both GET and POST on 259 of 279 endpoints — every operation was duplicated in the generated reference, cluttering the sidebar with ~520 entries. For each dual-method endpoint, kept whichever method matches REST semantics (GET for reads, POST for writes). Conservative approach: only removed a method when the operation summary or path unambiguously indicated the correct method; 17 genuinely ambiguous endpoints (auth, downloads, report rendering, commandParser variants) keep both methods. Result: 117 GET operations removed, 125 POST operations removed, 17 dual-method paths retained, sidebar reduced from ~520 to ~276 entries. Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
had a problem deploying
to
development
GitHub Actions
Error
Auto-Fix Summary4 issues fixed, 5 skipped across 7 files
| Ask |
Add scripts/deduplicate-openapi-methods.mjs — idempotent script that removes the redundant GET or POST from each dual-method endpoint in the Change Tracker Hub OpenAPI spec (an ASP.NET Swashbuckle artifact). Wire it into prestart/prebuild/preci so deduplication runs automatically before every gen-api-docs call. Add openapi:sync for manual use when a new spec is committed: deduplicates, cleans, regenerates, and restores _category_.json in one command. Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
had a problem deploying
to
development
GitHub Actions
Error
Auto-Fix Summary2 issues fixed, 0 skipped across 7 files
Ask |
Automatically deduplicates GET/POST on the Change Tracker Hub OpenAPI spec whenever static/openapi/*.yaml changes in a PR. Runs after push, commits the cleaned spec back to the branch — no manual steps needed. Uses the same VALE_TOKEN + loop-prevention pattern as vale-autofix.yml. Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
temporarily deployed
to
development
GitHub Actions
Inactive
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Auto-Fix Summary0 issues fixed, 0 skipped across 7 files Ask |
Documents the deduplication system, sidebar integration, OpenAPI spec quirks, and other technical context for future sessions. Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
temporarily deployed
to
development
GitHub Actions
Inactive
Auto-Fix Summary0 issues fixed, 7 skipped across 7 files
| Ask |
- agents.md: add backticks around Invoke-RestMethod and -SkipCertificateCheck - authentication.md: reorder description to match script's actual prompt order (URL → cert validation → credentials, not URL → credentials → cert) - overview.md: restore 'the central management server' gloss for Change Tracker Hub - reference/index.md: simplify Auth section instruction wording - register-agents.md: sentence-case 'Operating System' → 'operating system' for Os and KnownOsName rows to match OsUserSpecified row Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
DanPiazza-Netwrix
had a problem deploying
to
development
GitHub Actions
Error
Auto-Fix Summary0 issues fixed, 0 skipped across 7 files Ask |
DanPiazza-Netwrix
temporarily deployed
to
development
GitHub Actions
Inactive
Documentation PR ReviewEditorial Reviewdocs/changetracker/8.1/api/agents.md
docs/changetracker/8.1/api/authentication.md
docs/changetracker/8.1/api/credentials.md
docs/changetracker/8.1/api/overview.md
docs/changetracker/8.1/api/reference/index.md
docs/changetracker/8.1/api/register-agents.md
docs/changetracker/8.1/integration/overview.md
Summary5 editorial suggestions across 7 files. Vale and Dale issues are auto-fixed separately. What to do next: Comment
You can ask Claude anything about the review or about Netwrix writing standards.
|
Auto-Fix Summary0 issues fixed, 0 skipped across 7 files Ask |
3 participants
Summary
Test plan
Generated with AI
Co-Authored-By: Claude Code ai@netwrix.com