Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add JSON schema documenting logs #69

Merged
merged 12 commits into from
Sep 2, 2021
Merged

Add JSON schema documenting logs #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
cd5c242
Started documentation of Log API
abailly-iohk Aug 30, 2021
251f611
Add module to check conformance against JSON schema
abailly-iohk Aug 30, 2021
dad379b
Check conformance of Log messages with published JSON schema
abailly-iohk Aug 30, 2021
b08aabc
Document more node entries
abailly-iohk Aug 30, 2021
9dbf9dc
Fix external reference for Transaction and Utxo
abailly-iohk Aug 30, 2021
257413b
Use direct reference to file instead of id
abailly-iohk Aug 30, 2021
f9d7777
Add missing log entries
abailly-iohk Aug 31, 2021
8ed466d
Separate conformance and completeness properties for API
abailly-iohk Sep 1, 2021
84de8b5
Generalise completeness property to use arbitrary selector
abailly-iohk Sep 1, 2021
74a88b8
Apply suggestions from code review
abailly-iohk Sep 2, 2021
e729aef
Simplify the lens expression to check schema completeness
abailly-iohk Sep 2, 2021
6c528dd
Fix compilation errors
abailly-iohk Sep 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,9 @@ idea to do the following:

Documentation is published online at https://input-output-hk.github.io/hydra-poc from the [docs](docs/README.md) directory.

The latest specification for the `hydra-node` WebSocket API can be viewed [here](https://input-output-hk.github.io/json-schema-viewer/#/?url=https://raw.githubusercontent.com/input-output-hk/hydra-poc/master/hydra-node/api.yaml).
API Documentations are available for:
* The [WebSocket API](https://input-output-hk.github.io/json-schema-viewer/#/?url=https://raw.githubusercontent.com/input-output-hk/hydra-poc/master/hydra-node/api.yaml)
* The [Log API](https://input-output-hk.github.io/json-schema-viewer/#/?url=https://raw.githubusercontent.com/input-output-hk/hydra-poc/master/hydra-node/api-log.yaml)

[Haddock](https://www.haskell.org/haddock/) documentation is also published for each package:
* [hydra-prelude](https://input-output-hk.github.io/hydra-poc/haddock/hydra-prelude/index.html)
Expand Down
Loading