close
Skip to content

docs: API & Event stream documentation and format changes #5798 #5801#5979

Open
gayanath8 wants to merge 5 commits intohashgraph:developfrom
xeptagondev:feature/5801/5798
Open

docs: API & Event stream documentation and format changes #5798 #5801#5979
gayanath8 wants to merge 5 commits intohashgraph:developfrom
xeptagondev:feature/5801/5798

Conversation

@gayanath8
Copy link
Copy Markdown
Contributor

Issue Labels

#5798
#5801

Requirements

  • Audit all existing Guardian API endpoints and identify documentation gaps.
  • Improve documentation for every existing API endpoint, including: endpoint URL, HTTP method, authentication requirements, request payload schema with field descriptions, response payload schema, and error codes.
  • Add documentation for any API endpoints that are currently undocumented.
  • Generalize and clearly document each supported API block's execution payload structure.
  • Keep provisions in the documentation for dynamic fields defined by users within policies.
  • Provide example request/response pairs for common workflows.
  • Update the Application Events Module documentation page with comprehensive, current information about all available event types, their payloads, and usage patterns.
  • Fill in the External Events documentation page with all current event types supported by Guardian's event stream.
  • Each event type should be documented with: event name, trigger condition, payload structure, and example usage.
  • Include guidance on how external systems should subscribe to and consume these events.

Summary of Changes

  • Added documentation for previously undocumented API endpoints
  • Introduced the Policy Block API Execution Payloads guide
  • Reformatted all existing API documentation
  • Filled documentation gaps and restructured event stream docs
  • Corrected and expanded the execution payloads guide with source-verified block entries
  • Updated SUMMARY.md to reflect the reorganized structure.

- Add documentation for endpoints that are currently undocumented.
- Add documentation for dynamic fields defined by users.

Signed-off-by: gayanath8 <gayanathr@xeptagon.com>
- Change format of API level documentation(existing ones)
- Update Summary.md

Signed-off-by: gayanath8 <gayanathr@xeptagon.com>
- Fill the missing documentation gaps on some of docs
- Tranform docs into formatted version remove swagger format
- Modify even stream documentations

Signed-off-by: gayanath8 <gayanathr@xeptagon.com>
…cution payloads

Signed-off-by: gayanath8 <gayanathr@xeptagon.com>
@gayanath8 gayanath8 requested a review from a team as a code owner April 21, 2026 06:55
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