CARVIEW |
Select Language
HTTP/2 200
date: Sun, 27 Jul 2025 21:34:37 GMT
content-type: text/html; charset=utf-8
cache-control: max-age=0, private, must-revalidate
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
link: ; rel=preload; as=fetch; crossorigin=use-credentials
referrer-policy: no-referrer-when-downgrade
server-timing: issue_layout-fragment;desc="issue_layout fragment";dur=188.041537,issue_conversation_content-fragment;desc="issue_conversation_content fragment";dur=506.939459,issue_conversation_sidebar-fragment;desc="issue_conversation_sidebar fragment";dur=47.793676,nginx;desc="NGINX";dur=1.289064,glb;desc="GLB";dur=101.646976
strict-transport-security: max-age=31536000; includeSubdomains; preload
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With, Accept,Accept-Encoding, Accept, X-Requested-With
x-content-type-options: nosniff
x-frame-options: deny
x-voltron-version: a2eb102
x-xss-protection: 0
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=Ixfrhz1VmGJHTuQ7Ik4wZUGjE%2B7HDrFTfBmojxu2dwbgNQezcbfFnlfFVPSazW%2F6XCAGUwCxKGzSKg2FoX52lA4smktRY905qC5tk9YDoftpM8knk%2F9v%2B6dmzUJ29adkbQ1e41znzH2CG2KNoseB4fdp62odU2SJlJYeG3vKb7LooF3ARGOnoOZqH58i3rwYg7uhvEyoBdQI3c9ONO2Hx9KcRqDi3hnekE5W5zS7t8I71wPWvPGUDx0lv5qtA8QyOJQIQh8BkFoifrid7Rl73Q%3D%3D--B2ek21JHZCDt87Mu--1zTYn68ys%2F%2BZ7g9n0ta4mQ%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.392650625.1753652077; Path=/; Domain=github.com; Expires=Mon, 27 Jul 2026 21:34:37 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Mon, 27 Jul 2026 21:34:37 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: 8F1E:0A77:56B849:6FD826:68869B6D
Issue with subresources not annotated with @Path · Issue #633 · swagger-api/swagger-core · GitHub
No one assignedNo labelsNo typeNo projectsNo milestoneNone yetNo branches or pull requests
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Closed
Description
Hi !
If you have a resource such as:
@Path("test")
@Produces(MediaType.APPLICATION_JSON)
@Api("test")
public class TestResource
{
@Path("/status")
@GET
@ApiOperation("Get status")
public String getStatus()
{
return "{\"status\":\"OK!\"}";
}
@Path("/more")
public TestSubResource getSubResource()
{
return new TestSubResource();
}
}
and a subresource such as:
@Produces(MediaType.APPLICATION_JSON)
public class TestSubResource
{
@Path("/otherStatus")
@GET
@ApiOperation("Get the other status!")
public String otherStatus()
{
return "{\"a\":\"Still Ok!\"}";
}
}
When accessing the Swagger spec under /api-docs/
, you will get the following result:
{
"apiVersion": "v9",
"swaggerVersion": "1.2",
"apis": [
{
"path": "/test"
}
]
}
Under /api-docs/test
you will get the following result:
{
"apiVersion": "v9",
"swaggerVersion": "1.2",
"basePath": "/rest",
"resourcePath": "/test",
"produces": [
"application/json"
],
"apis": [
{
"path": "/test/status",
"operations": [
{
"method": "GET",
"summary": "Get status",
"notes": "",
"type": "void",
"nickname": "getStatus",
"parameters": [ ]
}
]
}
]
}
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 the TestSubResource
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 the TestResource
resource using example.org/test/more/otherStatus
.
EDIT: typos
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Milestone
Relationships
Development
Issue actions
You can’t perform that action at this time.