Skip to content

Commit

Permalink
chore: Document OpenRPC API and schemas
Browse files Browse the repository at this point in the history
  • Loading branch information
bgins committed Feb 13, 2024
1 parent d4d196c commit eaf66b1
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions homestar-runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,17 @@ and failure modes, etc.
For more information, please go to our [Homestar Readme][homestar-readme].

[homestar-readme]: https://github.com/ipvm-wg/homestar/blob/main/README.md

## API

The runtime provides a JSON-RPC API to run workflows, request node information, health, and metrics, and to subscribe to network notifications. The OpenRPC API is documented in [api.json][api] and is available on the `rpc_discover` endpoint.

JSON Schemas for [workflow][workflow-schema], [receipt][receipt-schema], [network notifications][network-schema], [health checks][health-schema], [node info][node-info-schema], and [metrics][metrics-schema] are also available inidividually.

[api]: ./schemas/api.json
[health-schema]: ./schemas/health.json
[metrics-schema]: ./schemas/metrics.json
[network-schema]: ./schemas/network.json
[node-info-schema]: ./schemas/node_info.json
[receipt-schema]: ./schemas/receipt.json
[workflow-schema]: ./schemas/workflow.json

0 comments on commit eaf66b1

Please sign in to comment.