메뉴
Verify that Swagger UI (or equivalent API documentation interface) is properly served and the raw OpenAPI spec is accessible over HTTP. Load when checking that API documentation is publicly available and functional.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
Jira issue lifecycle for the build agent. Load this skill when the issue tracker provider is "jira" in agent-config.json. Covers session start, progress tracking, status transitions, and PR linking.
Working with Gitea issues — reading tickets, posting progress updates, and managing dependencies. Load this skill at the start of any session where a Gitea issue number is provided.
GitHub issue lifecycle for the build agent. Load this skill when the issue tracker provider is "github" in agent-config.json. Covers session start, progress tracking, and PR linking.
Git worktree lifecycle for isolated per-ticket workstreams. Load this skill whenever the user describes a problem to solve or asks to claim a ticket, before any implementation work begins.
End-to-end testing conventions using Playwright. Covers writing E2E tests, test execution, project setup, and failure reporting. Load when writing, running, or evaluating E2E tests.
Roadmap management, task logging, and sprint planning conventions for this project. Load when managing ROADMAP.md, writing task logs, or planning a batch of work.
| name | swagger-ui-verification |
| description | Verify that Swagger UI (or equivalent API documentation interface) is properly served and the raw OpenAPI spec is accessible over HTTP. Load when checking that API documentation is publicly available and functional. |
| license | MIT |
| compatibility | opencode |
This skill verifies that API documentation is served correctly over HTTP. It checks two things: that a human-readable documentation UI (Swagger UI, Redoc, Scalar, etc.) is accessible, and that the raw OpenAPI spec file can be fetched programmatically.
The dev server must be running before these checks. If you are also loading the openapi-spec-verification skill, reuse the same running server — do not start a second one.
Check these common documentation endpoints in order:
GET /docs
GET /api-docs
GET /swagger
GET /reference
GET /docs/
GET /api/docs
At least one must return an HTML page. Verify:
text/htmlswagger-ui, redoc, scalar, openapi, or api-reference in the HTML)If none of these endpoints return a documentation UI, report as major. Include which endpoints were tried and what responses were received.
Check these endpoints for the raw OpenAPI spec:
GET /openapi.yaml
GET /openapi.json
GET /docs/openapi.yaml
GET /docs/openapi.json
GET /api-docs/openapi.yaml
GET /api/openapi.yaml
GET /api/openapi.json
At least one must return a valid OpenAPI spec. Verify:
openapi version field (e.g., openapi: "3.0.0" or "openapi": "3.1.0")paths object with at least one pathIf none of these endpoints return a valid spec, report as major.
If both the documentation UI and raw spec are accessible, verify they reference the same spec. The documentation UI typically loads the spec from a URL — check that the URL it references matches one of the raw spec endpoints that returned a valid response.
If the documentation UI loads a spec from a different source than the file on disk, note this as minor — it may indicate a configuration issue where the served spec diverges from the source spec.