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

@RepositoryRestResource Example #644

Closed
JoeMcCaffrey opened this issue May 4, 2020 · 4 comments
Closed

@RepositoryRestResource Example #644

JoeMcCaffrey opened this issue May 4, 2020 · 4 comments
Labels
enhancement New feature or request

Comments

@JoeMcCaffrey
Copy link

Hello - Is RepositoryRestResource supported at all?

I have tried to annotate with @operation but can't seem to get it to work.

I've also searched for a unit test with RepositoryRestResource as an example but cannot find one.

Can one annotate with @operation without a @path or HTTP Verb? (@get)

@bnasslahsen
Copy link
Contributor

Hi @JoeMcCaffrey,

If you didn't find any unit test about it, that simply means not yet supported.
Its also listed here:

You can have a look at my answer for the reasons:

One of the main goals of springdoc-openapi is to achieve automatic documentation generation (when possible).

The support of @RepositoryRestResource, just was not the priority as there was no simple way for the automatic generation at application startup.

But for the manual annotations, even the @Operation does not contain the path, it can be added for the next release (hopefully).

You can also contribute to add the support if you feel conforable with this topic...

@jdbranham
Copy link

@bnasslahsen - any pointers/tips if I were to attempt contribution of this functionality?

@bnasslahsen
Copy link
Contributor

Hi @jdbranham, @JoeMcCaffrey,

I have started looking at the support of the @RepositoryRestResource out of the box.
I will push a first version to master today and you can have a look for enhancements.

We hopefully will release the first support @RepositoryRestResource by the end of this week (Friday 29th May).

@jdbranham
Copy link

That's great! I'll test it in my current project!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants