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

feat: add chainhook docs api generate command #323

Merged
merged 12 commits into from
Jul 12, 2023
Merged

feat: add chainhook docs api generate command #323

merged 12 commits into from
Jul 12, 2023

Conversation

MicaiahReid
Copy link
Contributor

@MicaiahReid MicaiahReid commented Jul 7, 2023

Fixes #251.

I've update chainhook-openapi.json, and I've added the chainhook docs api generate command to regenerate the spec as the api changes.

We should update the chainhook-openapi.json as part of our deployment process eventually.

Also, this introduces us using a fork of schemars and okapi. I've created PRs in this repo so we can hopefully use the stable version again before too long.

@lgalabru
Copy link
Contributor

Thanks @MicaiahReid! did you fix the spec manually? Asking because I'd like to augment one of the core schema in another PR.

@MicaiahReid
Copy link
Contributor Author

@lgalabru Yes, sadly I did do this manually.

I've started looking into opening a PR to fix these two:

I think that would make the autogenerated schema correct

@MicaiahReid MicaiahReid changed the title fix: update open api spec feat: add chainhook docs api generate command Jul 12, 2023
@@ -38,9 +38,13 @@ atty = "0.2.14"
crossbeam-channel = "0.5.8"
uuid = { version = "1.3.0", features = ["v4", "fast-rng"] }
threadpool = "1.8.1"
rocket_okapi = "0.8.0-rc.3"
rocket_okapi = { version = "0.8.0-rc.3", git = "https://github.com/MicaiahReid/okapi.git", branch = "feat-chainhook-fixes"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we host the fork under the hirosystems org?

Copy link
Contributor Author

@MicaiahReid MicaiahReid Jul 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why must you thwart my plans for github significance?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!

@MicaiahReid MicaiahReid changed the base branch from develop to archiveChainhooks July 12, 2023 20:35
@MicaiahReid MicaiahReid changed the base branch from archiveChainhooks to develop July 12, 2023 20:35
@MicaiahReid MicaiahReid marked this pull request as ready for review July 12, 2023 21:06
Copy link
Contributor

@lgalabru lgalabru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great! just a few adjustment on dependencies.

@lgalabru lgalabru merged commit 657d988 into develop Jul 12, 2023
@lgalabru lgalabru deleted the openapi branch July 12, 2023 21:43
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.

OpenAPI documentation
2 participants