Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Method level reader extensions #1513

Merged
merged 1 commit into from
Aug 12, 2016
Merged

Conversation

kendzi
Copy link

@kendzi kendzi commented Oct 22, 2015

It should be possible to enrich swagger model by vendor based extensions stored on operation level. To do that we need to add extension point when operation is processed and method context exists. This allow to process e.g. some vendor annotation which are stored on method level and could be used by documentation.

@webron
Copy link
Contributor

webron commented Oct 26, 2015

Not entirely sure what's your end goal here, but you should definitely add a test for it (which would also explain your case).

@kendzi
Copy link
Author

kendzi commented Nov 3, 2015

I added example as you asked. In short lets assume that come company created set of annotation which could be used on method level e.g. "@VendorFunnyAnnotation". If it is used this indicates that that method could return some error code and we would like to add that error code to swagger documentation.

@webron
Copy link
Contributor

webron commented Mar 1, 2016

@frantuma can you review this please?

@frantuma
Copy link
Member

frantuma commented Mar 2, 2016

@webron @kendzi
It looks good to me, but it needs to be rebased and to have SimpleResourceWithVendorAnnotation annotated with @Path("/") at class level to allow it to be scanned during test.

@kendzi kendzi force-pushed the method-extension branch from 23c32e7 to 8ad7fe4 Compare March 4, 2016 11:44
kendzi added a commit to kendzi/swagger-core that referenced this pull request Mar 4, 2016
@kendzi
Copy link
Author

kendzi commented Mar 4, 2016

done

@kendzi kendzi force-pushed the method-extension branch from 8ad7fe4 to ed2e4d8 Compare March 8, 2016 15:11
@kendzi kendzi force-pushed the method-extension branch from ed2e4d8 to 7702596 Compare March 8, 2016 15:28
kendzi added a commit to kendzi/swagger-core that referenced this pull request Mar 8, 2016
@kendzi
Copy link
Author

kendzi commented Mar 9, 2016

@webron @frantuma anything else should I rebase of fix?

@sunlaud
Copy link

sunlaud commented May 10, 2016

Upvote this pull request! It really simplifies unobtrusive tuning of documentation generation process.
Are there any reasons why not to merge?

@iherasymenko
Copy link

+1

@kendzi kendzi force-pushed the method-extension branch from 7702596 to 8d706dd Compare May 13, 2016 12:26
@kendzi
Copy link
Author

kendzi commented May 13, 2016

I re-base it once again. Please merge it.

@sunlaud
Copy link

sunlaud commented Aug 3, 2016

@webron @frantuma guys, are there any reasons why this PR can not be merged?

@webron
Copy link
Contributor

webron commented Aug 3, 2016

Time 😕

@frantuma since you reviewed it in the past, feel free to merge if you feel confident about it.

@frantuma frantuma merged commit f9f0e37 into swagger-api:master Aug 12, 2016
@fehguy fehguy modified the milestone: 1.5.10 Dec 25, 2016
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants