Open
Conversation
- Add deprecation notice pointing to the v2 API - Add data model overview table explaining object relationships - Add central object/action reference table - Extract repeated endpoint URL and auth header into shared preamble - Document the values field format (semicolon/pipe convention) globally - Explain add vs set semantic difference once at the top level - Add representative examples for all previously list-only objects (ACL, ACLACTION, ACLGROUP, ACLMENU, ACLRESOURCE, CENTBROKERCFG, CGICFG, CMD, CONTACT, CONTACTTPL, CG, DEP, DOWNTIME, HTPL, HC, HG, INSTANCE, STPL, SERVICE, SG, SC, TIMEPERIOD, TRAP, VENDOR) - Document values field positional order for each add action - Add authentication token lifecycle information - Add pagination documentation for realtime endpoints - Add error response example in the error codes section - Add curl examples for authentication and configuration calls - Add type and description columns to realtime field tables - Document state integer values inline (0=OK, 1=WARNING, etc.) - Fix typos: applyed, befores, icone, criticity, fo this, event-handfler - Normalize object names to uppercase to match CLAPI convention Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The REST API v1 documentation was poorly structured, highly repetitive,
and left most objects with no usage examples. This PR rewrites the page
to make it actually useful as a reference.
supported objects and their available actions
table that appeared 50+ times are now defined once per section
pipe-separated multiple values)
addvssetsemantics explained once at the top rather thaninconsistently per-endpoint
had a bullet list of action names (ACL, ACLACTION, ACLGROUP, ACLMENU,
ACLRESOURCE, CENTBROKERCFG, CGICFG, CMD, CONTACT, CONTACTTPL, CG,
DEP, DOWNTIME, HTPL, HC, HG, INSTANCE, STPL, SERVICE, SG, SC,
TIMEPERIOD, TRAP, VENDOR), including documented
valuesfield orderfor each
addactionevent-handfler
Target version (i.e. version that this PR changes)