Lomo CodeSecurity

The API reference is in English.

Current source preview reference

POST /v1/sources/preview

Preview source. Permissions, parameters, responses and examples.

0.1.0 · source bccff29 · Immutable snapshot · Download OpenAPI specification

Read pinned handler: apps/api/kodesec_api/main.py:4082

Preview source

Preview source through POST /v1/sources/preview. The parameters and declared response shapes below come from this exact source snapshot.

Source preview; no stable third-party integration promise. This page makes no request to a local installation.

Authority

Browser operator session or exact IDE capability with project:resolve. Route-specific ownership and generation checks also apply.

Browser mutations require the exact control Origin and session-bound CSRF header. IDE callers use only their admitted route scope and exact generation.

Inspect the authority source · Authentication guide

Parameters and headers

NameLocationContract
X-CSRF-Tokenheader
Conditional / optional

Required for browser mutations with the exact control Origin. Not an IDE capability.

Schema
{
  "type": "string"
}

Request body

JSON body · required · SourcePreviewRequest

FieldTypePresence
repo_pathstringRequired
Complete declared request schema
{
  "additionalProperties": false,
  "properties": {
    "repo_path": {
      "maxLength": 4096,
      "minLength": 1,
      "title": "Repo Path",
      "type": "string"
    }
  },
  "required": [
    "repo_path"
  ],
  "title": "SourcePreviewRequest",
  "type": "object"
}

Responses

StatusMeaning and declared shape
200

Successful Response

application/json · SourcePreviewOut
{
  "additionalProperties": false,
  "description": "Configured mount authorization only; scan admission rechecks source safety.",
  "properties": {
    "authorization_mode": {
      "const": "mounted",
      "default": "mounted",
      "title": "Authorization Mode",
      "type": "string"
    },
    "authorized": {
      "title": "Authorized",
      "type": "boolean"
    },
    "configured_roots": {
      "items": {
        "type": "string"
      },
      "maxItems": 32,
      "minItems": 1,
      "title": "Configured Roots",
      "type": "array"
    },
    "installation_id": {
      "pattern": "^[0-9a-f]{12}$",
      "title": "Installation Id",
      "type": "string"
    },
    "reason_code": {
      "anyOf": [
        {
          "const": "source_outside_allowed_root",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reason Code"
    },
    "repo_path": {
      "title": "Repo Path",
      "type": "string"
    }
  },
  "required": [
    "installation_id",
    "repo_path",
    "authorized",
    "configured_roots",
    "reason_code"
  ],
  "title": "SourcePreviewOut",
  "type": "object"
}
400

Exact host, malformed request or URL credential refusal

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
401

Missing or invalid membership

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
403

Exact origin, CSRF or route authority refusal

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
422

Validation Error

application/json · HTTPValidationError
{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "title": "Detail",
      "type": "array"
    }
  },
  "title": "HTTPValidationError",
  "type": "object"
}
429

Authentication rate or connection limit

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}

An empty or broad schema preserves the source contract. It is not a promise of an empty response.

Source-linked errors

Literal HTTP errors in this handler and same-file helper call graph, plus control middleware. Dynamic and cross-module failures may add other errors; source links are authoritative.

No literal handler errors were found by the bounded source extractor. Middleware and dependent operations can still fail.

Read the recovery guide

Synthetic examples

These examples validate declared JSON shapes and formats. They contain no real installation data and do not prove runtime admission, cross-field validation, authority or successful work.

Request JSON
{
  "repo_path": "/workspace/synthetic-demo"
}
Response 200 JSON
{
  "authorized": false,
  "configured_roots": [
    "synthetic"
  ],
  "installation_id": "000000000000",
  "reason_code": "source_outside_allowed_root",
  "repo_path": "/workspace/synthetic-demo"
}
Download this service's complete OpenAPI

All referenced models remain in its components section. Browse control model definitions.