Skip to content

docs(api-reference): add REST API reference#3

Open
rootxharsh wants to merge 2 commits intomainfrom
docs/rest-api-reference
Open

docs(api-reference): add REST API reference#3
rootxharsh wants to merge 2 commits intomainfrom
docs/rest-api-reference

Conversation

@rootxharsh
Copy link
Copy Markdown

Adds a full Mintlify API Reference covering the public REST API (scans, findings, cost estimations) plus introduction, authentication, rate limits, pagination/filtering, and errors. Wires the new tab into docs.json navigation and surfaces it on the home page.

The Swagger UI rendered from the live OpenAPI spec at https://api.hacktron.ai/api-docs is linked from the introduction and authentication pages. The canonical base URL is https://api.hacktron.ai/api/v1/rest, matching the path shape the OpenAPI spec emits so Swagger "Try it out" and generated SDKs work against the public host directly.

rootxharsh and others added 2 commits April 18, 2026 23:27
Adds a full Mintlify API Reference covering the public REST API
(scans, findings, cost estimations) plus introduction, authentication,
rate limits, pagination/filtering, and errors. Wires the new tab into
docs.json navigation and surfaces it on the home page.

Every page is validated against the IVA REST controllers and DTOs;
notable corrections against the initial draft:
- SARIF export filename is `findings-<scanId>.sarif`, not `.sarif.json`
- Triage thread `reaction` holds a FindingState value, not
  `thumbs_up`/`thumbs_down`

The Swagger UI rendered from the live OpenAPI spec at
https://api.hacktron.ai/api-docs is linked from the introduction and
authentication pages. The canonical base URL is
https://api.hacktron.ai/api/v1/rest, matching the path shape the
OpenAPI spec emits so Swagger "Try it out" and generated SDKs work
against the public host directly.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.

2 participants