-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Issue with subresources not annotated with @Path #633
Comments
I feel that a @ApiSubResource annotation would resolve the issue. |
Ran into the same issue, GuiSim may be right, but I leave that to you guys. I think it shouldnt be necessary to annotate SubResources as such |
I had another issue related to this one I think, so I post it into here: Main resource A, Sub resource B Sub resource B has a resource C linked to it, accessible through: A POST operation "O" in C has the path: The problem here is that swagger wont recognize that I have 2 path parameter variables in there which need to be specified in order to reach the operation. It just "notices" one of them (driverId). As a workaround, I had to specify the path parameter siteId in the "O" operation in C with ApiImplicitParams. This then worked. |
The @Api(hidden = true) has been added in 1.3.8. See sample here: https://github.com/wordnik/swagger-core/tree/master/samples/java-jaxrs-subresource |
this should be fixed in 1.3.8. You can add a "hidden" value to the @Api operation to hide the resource completely, except in the case of being a subresource. |
Hi !
If you have a resource such as:
and a subresource such as:
When accessing the Swagger spec under
/api-docs/
, you will get the following result:Under
/api-docs/test
you will get the following result:As you can see, the
/test/more/otherStatus
method is not documented in the Swagger spec.Adding the @Api annotation on the
TestSubResource
sub resource fixes the issue but introduces a new one. Now the calls are documented correctly in/api-docs/test
BUT the methods under theTestSubResource
resource are visible under/api-docs
.This should not be the case as
example.org/more/otherStatus
is not a valid API call. It is only accessible through theTestResource
resource usingexample.org/test/more/otherStatus
.EDIT: typos
The text was updated successfully, but these errors were encountered: