Skip to content

docs: overhaul REST API v1 documentation#5063

Open
Nohzoh wants to merge 1 commit intostagingfrom
docs/improve-rest-api-v1-documentation
Open

docs: overhaul REST API v1 documentation#5063
Nohzoh wants to merge 1 commit intostagingfrom
docs/improve-rest-api-v1-documentation

Conversation

@Nohzoh
Copy link
Copy Markdown
Contributor

@Nohzoh Nohzoh commented Feb 19, 2026

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.

  • Deprecation notice added at the top, pointing readers to the v2 API
  • Data model overview explaining all objects and their relationships
  • Central object/action reference table as a quick lookup for all
    supported objects and their available actions
  • Shared request format — the repeated endpoint URL and auth header
    table that appeared 50+ times are now defined once per section
  • Values format explained globally (semicolon-separated fields,
    pipe-separated multiple values)
  • add vs set semantics explained once at the top rather than
    inconsistently per-endpoint
  • Representative examples added for every object that previously only
    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 values field order
    for each add action
  • Authentication section now documents token lifecycle
  • Pagination documented with a dedicated section in the Realtime API
  • Error response example added to the error codes section
  • curl examples added for authentication and the configuration pattern
  • State values documented inline (e.g. 0=OK, 2=DOWN, 3=UNREACHABLE)
  • Typos fixed: applyed, befores, icone, criticity, fo this,
    event-handfler

Target version (i.e. version that this PR changes)

  • 24.04.x
  • 24.10.x
  • 25.10.x
  • 26.10.x
  • Cloud
  • Monitoring Connectors
  • DEM
  • Log Management

- 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>
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.

1 participant