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.

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

🛠️ [TASK] : Define the initial API surface for the crate (See Description for high level overview of API requirements). #12

Closed
Tracked by #10
stevenj opened this issue Nov 29, 2023 · 0 comments · Fixed by #33 or input-output-hk/catalyst-ci#126
Assignees

Comments

@stevenj
Copy link
Collaborator

stevenj commented Nov 29, 2023

Summary

Defines the high level API for all planned api functions

Description

Functions should effectively be No-ops, and not have any real functionality yet.
It just defines the configuration structures and the API surface itself.
At the end of this the API should be fully defined and properly documented and Rust docs being produced.
Review of the produced rust-docs will be necessary to sign off on this task.

This task is better as a collaborative effort between 2 developers, with a review by the whole team following that.
API to follow architectural guidance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
3 participants