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

build: update openapiv3 to v2.0 #525

Merged
merged 1 commit into from
Oct 20, 2024
Merged

build: update openapiv3 to v2.0 #525

merged 1 commit into from
Oct 20, 2024

Conversation

tiagolobocastro
Copy link
Collaborator

There's a breaking change on the crate which does not expose the fields as pub and so we need to use our own patch for now.

@tiagolobocastro
Copy link
Collaborator Author

Raised PR on openapiv3: glademiller/openapiv3#86

@tiagolobocastro tiagolobocastro changed the title build: update to openapiv3 build: update openapiv3 to v2.0 Jun 30, 2024
@tiagolobocastro
Copy link
Collaborator Author

The raised PR is still not reviewed, I wonder if the repo is no longer maintained.
So we'd have to consider forking or switching to another crate in order to make progress here and in the other PR which is depending on this one...
@Sufflope @formlogic-kirk @snaggen @RaulTrombin @thomedw what are your thoughts here?

@thomedw
Copy link
Contributor

thomedw commented Oct 15, 2024

Hi @tiagolobocastro,

There's a crate called openapiv3-extended, which is a fork of the repository you mentioned. It might be worth checking out.

I think it has the required pub fields https://github.com/kurtbuilds/openapiv3/blob/master/src/security_scheme.rs#L67.

@tiagolobocastro
Copy link
Collaborator Author

Hi @tiagolobocastro,

There's a crate called openapiv3-extended, which is a fork of the repository you mentioned. It might be worth checking out.

I think it has the required pub fields https://github.com/kurtbuilds/openapiv3/blob/master/src/security_scheme.rs#L67.

I did not know this, thank you! I'll take a look

There's a breaking change on the crate which does not expose the fields as pub
and so we need to use our own patch for now.
In fact, we can't merge this upstream (not maintained) so instead we move to
a fork of our own.
Since this is not part of our public api this should be fairly self contained.

Signed-off-by: Tiago Castro <[email protected]>
@tiagolobocastro
Copy link
Collaborator Author

Seems like updating to the extended crate would take a few changes, and we might have to raise a PR there as well.
To avoid going through this loop again, I've added a new crate, a simple fork with just these changes.
Since openapiv3 is not part of the public api yet, this should be fairly harmless but we do need to consider how to progress forward.

@tiagolobocastro tiagolobocastro merged commit 3da20d8 into master Oct 20, 2024
7 checks passed
@tiagolobocastro tiagolobocastro deleted the openapiv3 branch October 20, 2024 16:58
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.

2 participants