You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
While we use servant to describe the API types in the hydra-explorer, the actual api/*.yaml openapi schemas are the interface to be used by observers and clients.
We want to ensure that the implementation (through servant-server) is matching what is claimed in the openapi schema through some automated testing (and stays that way).
What
Add a test suite that fails if we change the ObservationApi Haskell type (or its constituents), but not the openapi schema in observer-api.yaml#paths/" /observations/{network}/{version}"
Add a test suite that fails if we change the ClientApi Haskell type (or its constituents), but not the openapi schema in client-api.yaml#paths/\/ticks or client-api.yaml#paths/\/heads
The text was updated successfully, but these errors were encountered:
Why
While we use
servant
to describe the API types in the hydra-explorer, the actualapi/*.yaml
openapi schemas are the interface to be used by observers and clients.We want to ensure that the implementation (through
servant-server
) is matching what is claimed in the openapi schema through some automated testing (and stays that way).What
ObservationApi
Haskell type (or its constituents), but not the openapi schema inobserver-api.yaml#paths/" /observations/{network}/{version}"
ClientApi
Haskell type (or its constituents), but not the openapi schema inclient-api.yaml#paths/\/ticks
orclient-api.yaml#paths/\/heads
The text was updated successfully, but these errors were encountered: