Skip to content

openapi3: introduce ReferencesComponentInRootDocument(doc *T, ref componentRef) (string, bool) #945

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
Merged
fenollp merged 11 commits into from
Jun 16, 2024
Merged

openapi3: introduce ReferencesComponentInRootDocument(doc *T, ref componentRef) (string, bool) #945

fenollp merged 11 commits into from
Jun 16, 2024

Conversation

@percivalalb
Copy link
Contributor

@percivalalb percivalalb commented Apr 22, 2024 •
edited
Loading

This MR adds a function (ReferencesComponentInRootDocument) to check if a component reference references the same document or element as another component reference in the root document's #/components/<type>. If it does, it returns the name of it in the form #/components/<type>/NameXXX.

It does this by keeping track of the source file paths of schemas in multi-file'd specs.

This enables the amalgamation of schemas which reference the same underlying model which removes very annoying to use anonymous structs in generated models when using codegen tools like oapi-codegen.

TODO: add MR in oapi-codegen displaying improved model generation. oapi-codegen/oapi-codegen#1573

@percivalalb percivalalb mentioned this pull request Apr 22, 2024
Open
@fenollp
Copy link
Collaborator

fenollp commented Apr 29, 2024

Hello!
How about a func that, given a doc and a Schema, returns a *SchemaRef (a ptr under doc) or nil? Would this not cover your use case?

Note: the refs.go file is generated.

@percivalalb
Copy link
Contributor Author

percivalalb commented Apr 30, 2024

Hello!

How about a func that, given a doc and a Schema, returns a *SchemaRef (a ptr under doc) or nil? Would this not cover your use case?

Note: the refs.go file is generated.

Yes, if it also returned the name in the #components/schemas/...

Input: doc, Schema
Output: name, SchemaRef

I'll have a look at moving it out of the gen'ed file

@percivalalb
Copy link
Contributor Author

percivalalb commented Jun 1, 2024

I've moved the alternations out of the code gen'ed files, sorry I'm still getting familar with the project setup and just thrown everything in the helper file. I'd like to ad some unit tests of couse but hopefully this is more to your liking.

@percivalalb percivalalb force-pushed the alb/reconsole-schema-refs branch 2 times, most recently from 3897eef to 11a0e6f Compare June 2, 2024 11:04
@percivalalb percivalalb mentioned this pull request Jun 2, 2024
Merged
@percivalalb percivalalb changed the title Add function to check if a schema matches one in root document Draft: Add function to check if a schema matches one in root document Jun 2, 2024
@fenollp
Copy link
Collaborator

fenollp commented Jun 2, 2024

This is looking pretty good!
Could you re-push the docs? It fails CI.
Also please send your tests away :) And an Example that shows usage of the function.

fenollp
fenollp reviewed Jun 2, 2024
View reviewed changes
@percivalalb
Copy link
Contributor Author

percivalalb commented Jun 2, 2024 •
edited
Loading

Things to do:

Heads up I'll be away for 10 days, so I won't be developing this PR for a bit

@percivalalb
Add function to check if a schema matches the root document's
4db371d 
It does this by keeping track of the source file paths of schemas in
multi-file'd specs.

This enables the amalgamation of schemas which reference the same underlying
model which removes *very annoying* to use anonymous structs in generated
models when using codegen tools like oapi-codegen.
@percivalalb
Move logic to code generation file
5318be2 
And populate all ref types
@percivalalb
Move MatchesSchemaInRootDocument to helper file
d5147d3
@percivalalb
Make matches root component function generic
773d4ff
@percivalalb
Protect against null refs
f9a50c8
@percivalalb
Update docs
56ad65a
@percivalalb
Add function comments
ccb4b14
@percivalalb
Replace swagger links with OAI spec
a68547e
@percivalalb
Fix bugs, rebase issues, add tests
c3fe41b
@percivalalb percivalalb force-pushed the alb/reconsole-schema-refs branch from 8de52a7 to c3fe41b Compare June 15, 2024 07:20
@percivalalb
Copy link
Contributor Author

percivalalb commented Jun 15, 2024 •
edited
Loading

Address most of the bullet points. Where is the best place for the example?

Edit: Added an example to the READMD.md

percivalalb
percivalalb commented Jun 15, 2024
View reviewed changes
@percivalalb percivalalb changed the title Draft: Add function to check if a schema matches one in root document Add function to check if a schema matches one in root document Jun 15, 2024
@fenollp fenollp changed the title Add function to check if a schema matches one in root document openapi3: introduce ReferencesComponentInRootDocument(doc *T, ref componentRef) (string, bool) Jun 16, 2024
@fenollp fenollp merged commit 061c378 into getkin:master Jun 16, 2024
@percivalalb percivalalb mentioned this pull request Jun 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fenollp fenollp fenollp approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@percivalalb @fenollp