Skip to content

Add OpenAPI documentation and Swagger UI - #182

Merged
llbbl merged 1 commit into
masterfrom
feature/issue-132-openapi-docs
Sep 18, 2026
Merged

llbbl merged 1 commit into
masterfrom
feature/issue-132-openapi-docs

Conversation

@llbbl

@llbbl llbbl commented Sep 18, 2026

Copy link
Copy Markdown
Owner

Closes #132

Summary

  • Add a reviewed OpenAPI 3.1 contract covering the v1 JSON API with concrete schemas and examples.
  • Serve the contract through a bundled Swagger UI page at /api/docs.
  • Enforce specification and route coverage in CI and document the contributor workflow.

Testing

  • composer test:all
  • composer test:integration:websocket
  • composer analyse
  • composer cs-check
  • pnpm check
  • pnpm api:lint
  • pnpm build
  • pnpm e2e
  • composer audit
  • Mutation testing was not run because it is manual-only.

Document the JSON API as a reviewed OpenAPI contract and expose it through a bundled Swagger UI page. Validate the specification and route coverage in CI so endpoint changes remain discoverable and synchronized with the implementation.
@socket-security

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addednpm/​swagger-ui-dist@​5.33.0100100849780
Addednpm/​yaml@​2.9.110010010092100
Addednpm/​@​stoplight/​spectral-cli@​6.16.39710010096100

View full report

@socket-security

Copy link
Copy Markdown

Warning

Review the following alerts detected in dependencies.

According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.

Action Severity Alert  (click "▶" to expand/collapse)
Warn High
Obfuscated code: npm as-table is 90.0% likely obfuscated

Confidence: 0.90

Location: Package overview

From: pnpm-lock.yaml → npm/@stoplight/spectral-cli@6.16.3 → npm/as-table@1.0.55

ℹ Read more on: This package | This alert | What is obfuscated code?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support@socket.dev.

Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/as-table@1.0.55. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn High
Obfuscated code: npm rollup is 90.0% likely obfuscated

Confidence: 0.90

Location: Package overview

From: pnpm-lock.yaml → npm/@stoplight/spectral-cli@6.16.3 → npm/rollup@2.80.0

ℹ Read more on: This package | This alert | What is obfuscated code?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support@socket.dev.

Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/rollup@2.80.0. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn High
Obfuscated code: npm yargs is 90.0% likely obfuscated

Confidence: 0.90

Location: Package overview

From: pnpm-lock.yaml → npm/@stoplight/spectral-cli@6.16.3 → npm/yargs@17.7.3

ℹ Read more on: This package | This alert | What is obfuscated code?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support@socket.dev.

Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/yargs@17.7.3. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

@llbbl
llbbl merged commit 2e6926a into master Sep 18, 2026
8 checks passed
@llbbl
llbbl deleted the feature/issue-132-openapi-docs branch September 18, 2026 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OpenAPI 3.1 spec for the v1 JSON API + Swagger UI

1 participant