---
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 or
look at the [hosted version](https://kodit.helix.ml/docs).
Code understanding platform with hybrid search and LLM-powered enrichments
Current version: 1.0.
## Base URL
| URL | Description |
|-----|-------------|
| //localhost:8080/api/v1 | |
## Authentication
### Security Schemes
| Name | Type | Description | Scheme | Bearer Format |
|-------------------|-------------------|--------------------------|---------------------|---------------------------|
| APIKeyAuth | apiKey | | | |
## APIs
### GET /enrichments
List enrichments with optional filters
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| enrichment_type | string | | Filter by enrichment type |
| enrichment_subtype | string | | Filter by enrichment subtype |
| page | integer | | Page number (default: 1) |
| page_size | integer | | Results per page (default: 20, max: 100) |
#### Responses
- 200: OK
[dto.EnrichmentJSONAPIListResponse](#dto.enrichmentjsonapilistresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /enrichments/{id}
Get an enrichment by ID
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Enrichment ID |
#### Responses
- 200: OK
[dto.EnrichmentJSONAPIResponse](#dto.enrichmentjsonapiresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### DELETE /enrichments/{id}
Delete an enrichment by ID
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Enrichment ID |
#### Responses
- 204: No Content
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### PATCH /enrichments/{id}
Update an enrichment's content
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Enrichment ID |
#### Request Body
[dto.EnrichmentUpdateRequest](#dto.enrichmentupdaterequest)
#### Responses
- 200: OK
[dto.EnrichmentJSONAPIResponse](#dto.enrichmentjsonapiresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /queue
List tasks in the queue
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| page | integer | | Page number (default: 1) |
| page_size | integer | | Results per page (default: 20, max: 100) |
| task_type | string | | Filter by task type |
#### Responses
- 200: OK
[dto.TaskListResponse](#dto.tasklistresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /queue/{task_id}
Get a task by ID
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| task_id | integer | True | Task ID |
#### Responses
- 200: OK
[dto.TaskResponse](#dto.taskresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories
Get all tracked Git repositories
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| page | integer | | Page number (default: 1) |
| page_size | integer | | Results per page (default: 20, max: 100) |
#### Responses
- 200: OK
[dto.RepositoryListResponse](#dto.repositorylistresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### POST /repositories
Add a new Git repository to track
#### Request Body
[dto.RepositoryCreateRequest](#dto.repositorycreaterequest)
#### Responses
- 200: Repository already exists
[dto.RepositoryResponse](#dto.repositoryresponse)
- 201: Repository created
[dto.RepositoryResponse](#dto.repositoryresponse)
- 400: Bad Request
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}
Get a repository by ID
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
#### Responses
- 200: OK
[dto.RepositoryDetailsResponse](#dto.repositorydetailsresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### DELETE /repositories/{id}
Delete a repository by ID
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
#### Responses
- 204: No Content
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/commits
List commits for a repository
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| page | integer | | Page number (default: 1) |
| page_size | integer | | Results per page (default: 20, max: 100) |
#### Responses
- 200: OK
[dto.CommitJSONAPIListResponse](#dto.commitjsonapilistresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/commits/{commit_sha}
Get a commit by SHA
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| commit_sha | string | True | Commit SHA |
#### Responses
- 200: OK
[dto.CommitJSONAPIResponse](#dto.commitjsonapiresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/commits/{commit_sha}/embeddings
This endpoint has been removed. Embeddings are an internal detail of snippets and enrichments.
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| commit_sha | string | True | Commit SHA |
#### Responses
- 410: Gone
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/commits/{commit_sha}/enrichments
List enrichments for a commit
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| commit_sha | string | True | Commit SHA |
| enrichment_type | string | | Filter by enrichment type |
| enrichment_subtype | string | | Filter by enrichment subtype |
| page | integer | | Page number (default: 1) |
| page_size | integer | | Results per page (default: 20, max: 100) |
#### Responses
- 200: OK
[dto.EnrichmentJSONAPIListResponse](#dto.enrichmentjsonapilistresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### DELETE /repositories/{id}/commits/{commit_sha}/enrichments
Delete all enrichments for a commit
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| commit_sha | string | True | Commit SHA |
#### Responses
- 204: No Content
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/commits/{commit_sha}/enrichments/{enrichment_id}
Get an enrichment by ID within commit context
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| commit_sha | string | True | Commit SHA |
| enrichment_id | integer | True | Enrichment ID |
#### Responses
- 200: OK
[dto.EnrichmentJSONAPIResponse](#dto.enrichmentjsonapiresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### DELETE /repositories/{id}/commits/{commit_sha}/enrichments/{enrichment_id}
Delete a specific enrichment from a commit
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| commit_sha | string | True | Commit SHA |
| enrichment_id | integer | True | Enrichment ID |
#### Responses
- 204: No Content
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/commits/{commit_sha}/files
List files for a commit
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| commit_sha | string | True | Commit SHA |
| page | integer | | Page number (default: 1) |
| page_size | integer | | Results per page (default: 20, max: 100) |
#### Responses
- 200: OK
[dto.FileJSONAPIListResponse](#dto.filejsonapilistresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/commits/{commit_sha}/files/{blob_sha}
Get a file by blob SHA
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| commit_sha | string | True | Commit SHA |
| blob_sha | string | True | Blob SHA |
#### Responses
- 200: OK
[dto.FileJSONAPIResponse](#dto.filejsonapiresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### POST /repositories/{id}/commits/{commit_sha}/rescan
Trigger a rescan of a specific commit
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| commit_sha | string | True | Commit SHA |
#### Responses
- 202: Accepted
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/commits/{commit_sha}/snippets
List code snippets for a commit (backed by enrichments)
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| commit_sha | string | True | Commit SHA |
| page | integer | | Page number (default: 1) |
| page_size | integer | | Results per page (default: 20, max: 100) |
#### Responses
- 200: OK
[dto.SnippetListResponse](#dto.snippetlistresponse)
- 401: Unauthorized
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/enrichments
List recent enrichments across commits for a repository
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| enrichment_type | string | | Filter by enrichment type |
| max_commits_to_check | integer | | Max commits to check (default: 100) |
| page | integer | | Page number (default: 1) |
| page_size | integer | | Results per page (default: 20, max: 100) |
#### Responses
- 200: OK
[dto.EnrichmentJSONAPIListResponse](#dto.enrichmentjsonapilistresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/status
Get indexing task status for a repository
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
#### Responses
- 200: OK
[dto.TaskStatusListResponse](#dto.taskstatuslistresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/status/summary
Get aggregated indexing status summary for a repository
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
#### Responses
- 200: OK
[dto.RepositoryStatusSummaryResponse](#dto.repositorystatussummaryresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### POST /repositories/{id}/sync
Trigger a sync (git fetch + branch scan + commit indexing) for a repository
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
#### Responses
- 202: Accepted
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/tags
List tags for a repository
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| page | integer | | Page number (default: 1) |
| page_size | integer | | Results per page (default: 20, max: 100) |
#### Responses
- 200: OK
[dto.TagJSONAPIListResponse](#dto.tagjsonapilistresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/tags/{tag_name}
Get a tag by name
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
| tag_name | string | True | Tag name |
#### Responses
- 200: OK
[dto.TagJSONAPIResponse](#dto.tagjsonapiresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### GET /repositories/{id}/tracking-config
Get current tracking configuration for a repository
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
#### Responses
- 200: OK
[dto.TrackingConfigResponse](#dto.trackingconfigresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### PUT /repositories/{id}/tracking-config
Update tracking configuration for a repository
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | integer | True | Repository ID |
#### Request Body
[dto.TrackingConfigUpdateRequest](#dto.trackingconfigupdaterequest)
#### Responses
- 200: OK
[dto.TrackingConfigResponse](#dto.trackingconfigresponse)
- 404: Not Found
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
### POST /search
Hybrid search across code snippets and enrichments
#### Request Body
[dto.SearchRequest](#dto.searchrequest)
#### Responses
- 200: OK
[dto.SearchResponse](#dto.searchresponse)
- 400: Bad Request
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
- 500: Internal Server Error
[middleware.JSONAPIErrorResponse](#middleware.jsonapierrorresponse)
## Components
### dto.CommitAttributes
| Field | Type | Description |
|-------|------|-------------|
| author | string | |
| commit_sha | string | |
| date | string | |
| message | string | |
| parent_commit_sha | string | |
### dto.CommitData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| id | string | |
| type | string | |
### dto.CommitJSONAPIListResponse
| Field | Type | Description |
|-------|------|-------------|
| data | array | |
| links | | |
| meta | | |
### dto.CommitJSONAPIResponse
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.EnrichmentAttributes
| Field | Type | Description |
|-------|------|-------------|
| content | string | |
| created_at | string | |
| subtype | string | |
| type | string | |
| updated_at | string | |
### dto.EnrichmentData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| id | string | |
| type | string | |
### dto.EnrichmentJSONAPIListResponse
| Field | Type | Description |
|-------|------|-------------|
| data | array | |
| links | | |
| meta | | |
### dto.EnrichmentJSONAPIResponse
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.EnrichmentSchema
| Field | Type | Description |
|-------|------|-------------|
| content | string | |
| type | string | |
### dto.EnrichmentUpdateAttributes
| Field | Type | Description |
|-------|------|-------------|
| content | string | |
### dto.EnrichmentUpdateData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| type | string | |
### dto.EnrichmentUpdateRequest
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.FileAttributes
| Field | Type | Description |
|-------|------|-------------|
| blob_sha | string | |
| extension | string | |
| mime_type | string | |
| path | string | |
| size | integer | |
### dto.FileData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| id | string | |
| type | string | |
### dto.FileJSONAPIListResponse
| Field | Type | Description |
|-------|------|-------------|
| data | array | |
| links | | |
| meta | | |
### dto.FileJSONAPIResponse
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.GitFileSchema
| Field | Type | Description |
|-------|------|-------------|
| blob_sha | string | |
| mime_type | string | |
| path | string | |
| size | integer | |
### dto.RepositoryAttributes
| Field | Type | Description |
|-------|------|-------------|
| cloned_path | string | |
| created_at | string | |
| last_scanned_at | string | |
| num_branches | integer | |
| num_commits | integer | |
| num_tags | integer | |
| remote_uri | string | |
| tracking_branch | string | |
| updated_at | string | |
### dto.RepositoryBranchData
| Field | Type | Description |
|-------|------|-------------|
| commit_count | integer | |
| is_default | boolean | |
| name | string | |
### dto.RepositoryCommitData
| Field | Type | Description |
|-------|------|-------------|
| author | string | |
| message | string | |
| sha | string | |
| timestamp | string | |
### dto.RepositoryCreateAttributes
| Field | Type | Description |
|-------|------|-------------|
| remote_uri | string | |
### dto.RepositoryCreateData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| type | string | |
### dto.RepositoryCreateRequest
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.RepositoryData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| id | string | |
| type | string | |
### dto.RepositoryDetailsResponse
| Field | Type | Description |
|-------|------|-------------|
| branches | array | |
| data | | |
| recent_commits | array | |
### dto.RepositoryListResponse
| Field | Type | Description |
|-------|------|-------------|
| data | array | |
| links | | |
| meta | | |
### dto.RepositoryResponse
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.RepositoryStatusSummaryAttributes
| Field | Type | Description |
|-------|------|-------------|
| message | string | |
| status | string | |
| updated_at | string | |
### dto.RepositoryStatusSummaryData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| id | string | |
| type | string | |
### dto.RepositoryStatusSummaryResponse
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.SearchAttributes
| Field | Type | Description |
|-------|------|-------------|
| code | string | |
| filters | | |
| keywords | array | |
| limit | integer | |
| text | string | |
### dto.SearchData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| type | string | |
### dto.SearchFilters
| Field | Type | Description |
|-------|------|-------------|
| authors | array | |
| commit_sha | array | |
| end_date | string | |
| enrichment_subtypes | array | |
| enrichment_types | array | |
| file_patterns | array | |
| languages | array | |
| sources | array | |
| start_date | string | |
### dto.SearchRequest
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.SearchResponse
| Field | Type | Description |
|-------|------|-------------|
| data | array | |
### dto.SnippetAttributes
| Field | Type | Description |
|-------|------|-------------|
| content | | |
| created_at | string | |
| derives_from | array | |
| enrichments | array | |
| original_scores | array | |
| updated_at | string | |
### dto.SnippetContentSchema
| Field | Type | Description |
|-------|------|-------------|
| language | string | |
| value | string | |
### dto.SnippetData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| id | string | |
| links | | |
| type | string | |
### dto.SnippetLinks
| Field | Type | Description |
|-------|------|-------------|
| commit | string | |
| file | string | |
| repository | string | |
### dto.SnippetListResponse
| Field | Type | Description |
|-------|------|-------------|
| data | array | |
| links | | |
| meta | | |
### dto.TagAttributes
| Field | Type | Description |
|-------|------|-------------|
| is_version_tag | boolean | |
| name | string | |
| target_commit_sha | string | |
### dto.TagData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| id | string | |
| type | string | |
### dto.TagJSONAPIListResponse
| Field | Type | Description |
|-------|------|-------------|
| data | array | |
| links | | |
| meta | | |
### dto.TagJSONAPIResponse
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.TaskAttributes
| Field | Type | Description |
|-------|------|-------------|
| created_at | string | |
| payload | | |
| priority | integer | |
| type | string | |
| updated_at | string | |
### dto.TaskData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| id | string | |
| type | string | |
### dto.TaskListResponse
| Field | Type | Description |
|-------|------|-------------|
| data | array | |
| links | | |
| meta | | |
### dto.TaskResponse
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.TaskStatusAttributes
| Field | Type | Description |
|-------|------|-------------|
| created_at | string | |
| current | integer | |
| error | string | |
| message | string | |
| progress | number | |
| state | string | |
| step | string | |
| total | integer | |
| updated_at | string | |
### dto.TaskStatusData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| id | string | |
| type | string | |
### dto.TaskStatusListResponse
| Field | Type | Description |
|-------|------|-------------|
| data | array | |
| links | | |
| meta | | |
### dto.TrackingConfigAttributes
| Field | Type | Description |
|-------|------|-------------|
| mode | | |
| value | string | |
### dto.TrackingConfigData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| type | string | |
### dto.TrackingConfigResponse
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.TrackingConfigUpdateAttributes
| Field | Type | Description |
|-------|------|-------------|
| mode | | |
| value | string | |
### dto.TrackingConfigUpdateData
| Field | Type | Description |
|-------|------|-------------|
| attributes | | |
| type | string | |
### dto.TrackingConfigUpdateRequest
| Field | Type | Description |
|-------|------|-------------|
| data | | |
### dto.TrackingMode
### jsonapi.Links
| Field | Type | Description |
|-------|------|-------------|
| first | string | |
| last | string | |
| next | string | |
| prev | string | |
| self | string | |
### jsonapi.Meta
### middleware.JSONAPIError
| Field | Type | Description |
|-------|------|-------------|
| detail | string | |
| id | string | |
| status | string | |
| title | string | |
### middleware.JSONAPIErrorResponse
| Field | Type | Description |
|-------|------|-------------|
| errors | array | |
