Skip to main content

Module rules

Module rules 

Source
Expand description

Protection rules and gitspaces.

Verified against the GitFox API v1.3.0 OpenAPI document:

OperationEndpoint
list rulesGET /api/v1/repos/{repo_ref}/rules
view ruleGET /api/v1/repos/{repo_ref}/rules/{rule_identifier}
list gitspacesGET /api/v1/gitspaces
view gitspaceGET /api/v1/gitspaces/{gitspace_identifier}
create gitspacePOST /api/v1/gitspaces
delete gitspaceDELETE /api/v1/gitspaces/{gitspace_identifier}
start / stopPOST …/gitspaces/{gitspace_identifier}/action
gitspace logsGET …/gitspaces/{gitspace_identifier}/logs/stream (SSE)

Gitspaces are an instance feature that can be switched off; an instance with them disabled answers the gitspace endpoints with a bare 500, so callers should check crate::SystemConfig::gitspace_enabled first.

Structs§

GitspacesApi
RulesApi