Skip to content

changetracker api sidebar stuff#916

Merged
jth-nw merged 20 commits into
mainfrom
dev
May 14, 2026
Merged

changetracker api sidebar stuff#916
jth-nw merged 20 commits into
mainfrom
dev

Conversation

@jth-nw
Copy link
Copy Markdown
Collaborator

@jth-nw jth-nw commented May 14, 2026

No description provided.

DanPiazza-Netwrix and others added 20 commits May 13, 2026 09:44
…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>
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>
…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>
…X parse error

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
- 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>
…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>
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>
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>
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>
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>
Opening a sidebar category now automatically collapses any previously
open sibling at the same level — accordion-style navigation matching
the pattern used by SailPoint and other large API reference sites.

Addresses the slow collapse delay in the Change Tracker API Reference
caused by many expanded sub-categories accumulating in the DOM.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
- 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>
…ollapse-categories

feat(sidebar): enable auto-collapse categories site-wide
…ker-api-auth-scheme

fix(changetracker): improve API auth UX and move API to top-level sidebar
@jth-nw jth-nw requested a review from a team as a code owner May 14, 2026 01:48
Comment on lines +37 to +44
- name: Checkout PR branch
if: steps.bot-check.outputs.skip != 'true'
uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.ref }}
token: ${{ secrets.VALE_TOKEN }}

- name: Configure git identity
@jth-nw jth-nw merged commit e7463f9 into main May 14, 2026
10 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.

3 participants