API Reference

Auto-generated by scripts/generate_api_docs.py on 2026-04-23T21:47:28+00:00.

OpenAPI Endpoints

Title: actsense - GitHub Actions Security Auditor
Version: 1.0.0
OpenAPI JSON: GET /openapi.json
Swagger UI: GET /docs
ReDoc: GET /redoc

Endpoints

`GET /api/analyses`

Summary: List Analyses Operation ID: list_analyses_api_analyses_get

List all saved analyses.

Parameters

Name	In	Required	Type	Description
`repository`	`query`	no	`string	null`
`limit`	`query`	no	`integer`

Responses

Status	Description	Content Types
`200`	Successful Response	application/json
`422`	Validation Error	application/json

`GET /api/analyses/{analysis_id}`

Summary: Get Analysis Operation ID: get_analysis_api_analyses__analysis_id__get

Get a specific analysis by ID.

Parameters

Name	In	Required	Type	Description
`analysis_id`	`path`	yes	`string`

Responses

Status	Description	Content Types
`200`	Successful Response	application/json
`422`	Validation Error	application/json

`DELETE /api/analyses/{analysis_id}`

Summary: Delete Analysis Operation ID: delete_analysis_api_analyses__analysis_id__delete

Delete an analysis by ID.

Parameters

Name	In	Required	Type	Description
`analysis_id`	`path`	yes	`string`

Responses

Status	Description	Content Types
`200`	Successful Response	application/json
`422`	Validation Error	application/json

`POST /api/audit`

Summary: Audit Operation ID: audit_api_audit_post

Audit a repository or action.

Request Body

Required: yes
application/json: AuditRequest

Responses

Status	Description	Content Types
`200`	Successful Response	application/json
`422`	Validation Error	application/json

`POST /api/audit/fix`

Summary: Audit Fix Operation ID: audit_fix_api_audit_fix_post

Audit YAML and return issues with concrete auto-fix suggestions.

Request Body

Required: yes
application/json: AuditYAMLRequest

Responses

Status	Description	Content Types
`200`	Successful Response	application/json
`422`	Validation Error	application/json

`POST /api/audit/stream`

Summary: Audit Stream Operation ID: audit_stream_api_audit_stream_post

Audit with Server-Sent Events for real-time progress.

Request Body

Required: yes
application/json: AuditRequest

Responses

Status	Description	Content Types
`200`	Successful Response	application/json
`422`	Validation Error	application/json

`POST /api/audit/yaml`

Summary: Audit Yaml Operation ID: audit_yaml_api_audit_yaml_post

Audit a raw YAML workflow file.

Request Body

Required: yes
application/json: AuditYAMLRequest

Responses

Status	Description	Content Types
`200`	Successful Response	application/json
`422`	Validation Error	application/json

`GET /api/health`

Summary: Health Operation ID: health_api_health_get

Health check endpoint.

Responses

Status	Description	Content Types
`200`	Successful Response	application/json

`GET /{full_path}`

Summary: Serve Frontend Operation ID: serve_frontend__full_path__get

Serve frontend for all non-API routes.

Parameters

Name	In	Required	Type	Description
`full_path`	`path`	yes	`string`

Responses

Status	Description	Content Types
`200`	Successful Response	application/json
`422`	Validation Error	application/json

Schemas

`AuditRequest`

Type: object
Description: No description.

Field	Type	Required	Description
`action`	`string	null`	no
`github_token`	`string	null`	no
`repository`	`string	null`	no
`use_clone`	`boolean`	no

`AuditYAMLRequest`

Type: object
Description: No description.

Field	Type	Required	Description
`github_token`	`string	null`	no
`yaml_content`	`string`	yes

`HTTPValidationError`

Type: object
Description: No description.

Field	Type	Required	Description
`detail`	`array<ValidationError>`	no

`ValidationError`

Type: object
Description: No description.

Field	Type	Required	Description
`loc`	`array<string	integer>`	yes
`msg`	`string`	yes
`type`	`string`	yes