Skip to content

docs(changetracker): update Hub API spec with shortened summaries and expanded descriptions#935

Merged
jth-nw merged 3 commits into
devfrom
DanPiazza-Netwrix/openapi-summary-cleanup
May 15, 2026
Merged

docs(changetracker): update Hub API spec with shortened summaries and expanded descriptions#935
jth-nw merged 3 commits into
devfrom
DanPiazza-Netwrix/openapi-summary-cleanup

Conversation

@DanPiazza-Netwrix
Copy link
Copy Markdown
Contributor

@DanPiazza-Netwrix DanPiazza-Netwrix commented May 15, 2026

Summary

  • Shortens all OpenAPI operation summary fields in changetracker-hub-8.1.yaml to six words or fewer
  • Expands all description fields with detailed, user-facing operation descriptions

Generated with AI

Co-Authored-By: Claude Code ai@netwrix.com

DanPiazza-Netwrix and others added 2 commits May 14, 2026 16:06
Shortens every summary field in the Change Tracker Hub OpenAPI spec to
six words or fewer so that API reference page headers are concise.
Detail from verbose summaries has been preserved in description fields.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
Rewrites every operation-level description in the Change Tracker Hub
OpenAPI spec to be professional, user-facing prose. No description is
now a verbatim copy of its summary. All 528 operations updated.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@jth-nw jth-nw merged commit 445ace5 into dev May 15, 2026
7 checks passed
jth-nw added a commit that referenced this pull request May 15, 2026
Merge pull request #935 from netwrix/DanPiazza-Netwrix/openapi-summary-cleanup

docs(changetracker): update Hub API spec with shortened summaries and expanded descriptions
@DanPiazza-Netwrix DanPiazza-Netwrix deleted the DanPiazza-Netwrix/openapi-summary-cleanup branch May 15, 2026 22:21
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