kodit 0.3.9__tar.gz → 0.3.11__tar.gz

{kodit-0.3.9 → kodit-0.3.11}/.github/workflows/test.yaml

@@ -17,6 +17,9 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-tags: true
+          fetch-depth: 0
 
       # Use the official Python action to set up Python because it is faster
       - name: "Set up Python"
@@ -32,14 +35,11 @@ jobs:
       - name: Install the project
         run: uv sync --locked --all-extras --dev
 
-      - name: Lint
-        run: uv run ruff check
-
-      - name: Run type checks
-        run: uv run mypy --config-file pyproject.toml .
+      - name: API Doc check
+        run: make openapi-check
 
       - name: Run tests
-        run: uv run pytest -s --cov=src --cov-report=xml tests/kodit
+        run: make test
 
   build-package:
     runs-on: ubuntu-latest

kodit-0.3.11/Makefile

@@ -0,0 +1,17 @@
+# Makefile for Kodit
+
+# Generate OpenAPI json schema from the FastAPI app
+openapi:
+	uv run src/kodit/utils/dump_openapi.py --out docs/reference/api/ kodit.app:app
+
+openapi-check: openapi
+	git diff --exit-code docs/reference/api/index.md
+
+type:
+	uv run mypy --config-file pyproject.toml .
+
+lint:
+	uv run ruff check --fix --unsafe-fixes
+
+test: lint type
+	uv run pytest -s --cov=src --cov-report=xml tests/kodit

{kodit-0.3.9 → kodit-0.3.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kodit
-Version: 0.3.9
+Version: 0.3.11
 Summary: Code indexing for better AI code generation
 Project-URL: Homepage, https://docs.helixml.tech/kodit/
 Project-URL: Documentation, https://docs.helixml.tech/kodit/

kodit-0.3.11/docs/reference/api/index.md

@@ -0,0 +1,361 @@
+---
+title: Server API Reference
+description: Kodit Server REST API Documentation
+weight: 30
+---
+
+This file is automatically generated from the Kodit server OpenAPI specification.
+You can view the live API documentation on the `/docs` endpoint of your Kodit server.
+
+
+This is the REST API for the Kodit server. Please refer to the
+[Kodit documentation](https://docs.helix.ml/kodit/) for more information.
+    
+Current version: 0.3.11
+
+## Authentication
+
+
+
+### Security Schemes
+
+| Name              | Type              | Description              | Scheme              | Bearer Format             |
+|-------------------|-------------------|--------------------------|---------------------|---------------------------|
+| Header (X-API-KEY) | apiKey | API key for authentication (only if set in environmental variables) |  |  |
+
+## APIs
+
+### GET /healthz
+
+Return a health check for the kodit API.
+
+
+#### Responses
+
+- 200: Successful Response
+
+- 500: Internal server error
+
+### GET /api/v1/indexes
+
+List all indexes.
+
+
+#### Responses
+
+- 200: Successful Response
+
+[IndexListResponse](#indexlistresponse)
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+### POST /api/v1/indexes
+
+Create a new index and start async indexing.
+
+
+#### Request Body
+
+[IndexCreateRequest](#indexcreaterequest)
+
+
+#### Responses
+
+- 202: Successful Response
+
+[IndexResponse](#indexresponse)
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+### GET /api/v1/indexes/{index_id}
+
+Get index details.
+
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| index_id | integer | True |  |
+
+
+#### Responses
+
+- 200: Successful Response
+
+[IndexDetailResponse](#indexdetailresponse)
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+- 404: Index not found
+
+### DELETE /api/v1/indexes/{index_id}
+
+Delete an index.
+
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| index_id | integer | True |  |
+
+
+#### Responses
+
+- 204: Successful Response
+
+- 500: Internal server error
+
+- 401: Unauthorized
+
+- 422: Invalid request
+
+- 404: Index not found
+
+### POST /api/v1/search
+
+Search code snippets with filters matching MCP tool.
+
+
+#### Request Body
+
+[SearchRequest](#searchrequest)
+
+
+#### Responses
+
+- 200: Successful Response
+
+[SearchResponse](#searchresponse)
+
+- 500: Internal server error
+
+- 422: Validation Error
+
+[HTTPValidationError](#httpvalidationerror)
+
+## Components
+
+
+
+### HTTPValidationError
+
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| detail | array |  |
+
+
+### IndexAttributes
+
+
+Index attributes for JSON:API responses.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| created_at | string |  |
+| updated_at | string |  |
+| uri | string |  |
+
+
+### IndexCreateAttributes
+
+
+Attributes for creating an index.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| uri | string | URI of the source to index |
+
+
+### IndexCreateData
+
+
+Data for creating an index.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| type | string |  |
+| attributes |  |  |
+
+
+### IndexCreateRequest
+
+
+JSON:API request for creating an index.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data |  |  |
+
+
+### IndexData
+
+
+Index data for JSON:API responses.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| type | string |  |
+| id | string |  |
+| attributes |  |  |
+
+
+### IndexDetailResponse
+
+
+JSON:API response for index details with included resources.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data |  |  |
+
+
+### IndexListResponse
+
+
+JSON:API response for index list.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data | array |  |
+
+
+### IndexResponse
+
+
+JSON:API response for single index.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data |  |  |
+
+
+### SearchAttributes
+
+
+Search attributes for JSON:API requests.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| keywords |  | Search keywords |
+| code |  | Code search query |
+| text |  | Text search query |
+| limit |  | Maximum number of results to return |
+| filters |  | Search filters |
+
+
+### SearchData
+
+
+Search data for JSON:API requests.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| type | string |  |
+| attributes |  |  |
+
+
+### SearchFilters
+
+
+Search filters for JSON:API requests.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| languages |  | Programming languages to filter by |
+| authors |  | Authors to filter by |
+| start_date |  | Filter snippets created after this date |
+| end_date |  | Filter snippets created before this date |
+| sources |  | Source repositories to filter by |
+| file_patterns |  | File path patterns to filter by |
+
+
+### SearchRequest
+
+
+JSON:API request for searching snippets.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data |  |  |
+
+
+### SearchResponse
+
+
+JSON:API response for search results.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| data | array |  |
+
+
+### SnippetAttributes
+
+
+Snippet attributes for JSON:API responses.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| content | string |  |
+| created_at | string |  |
+| updated_at | string |  |
+| original_scores | array |  |
+| source_uri | string |  |
+| relative_path | string |  |
+| language | string |  |
+| authors | array |  |
+| summary | string |  |
+
+
+### SnippetData
+
+
+Snippet data for JSON:API responses.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| type | string |  |
+| id | integer |  |
+| attributes |  |  |
+
+
+### ValidationError
+
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| loc | array |  |
+| msg | string |  |
+| type | string |  |