Skip to content

dsp-ingest-monitoring v0.16.0

Servers

Description URL
Local development server http://localhost:3340
Production server https://ingest.dasch.swiss

monitoring


GET /info

Response 200 OK

{
    "name": "dsp-ingest",
    "version": "v0.16.0",
    "scalaVersion": "3.3.4",
    "sbtVersion": "1.10.6",
    "buildTime": "2024-12-18 15:19:48.664+0000",
    "gitCommit": "8763e33ecac16dba6450256b5164462660fa5da6"
}
Schema of the response body
{
    "title": "InfoEndpointResponse",
    "type": "object",
    "required": [
        "name",
        "version",
        "scalaVersion",
        "sbtVersion",
        "buildTime",
        "gitCommit"
    ],
    "properties": {
        "name": {
            "type": "string"
        },
        "version": {
            "type": "string"
        },
        "scalaVersion": {
            "type": "string"
        },
        "sbtVersion": {
            "type": "string"
        },
        "buildTime": {
            "type": "string"
        },
        "gitCommit": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "id": "string",
    "type": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

{
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "errorMessage": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null,
    "components": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

GET /health

Response 200 OK

{
    "status": "UP"
}
Schema of the response body
{
    "title": "AggregatedHealth",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

Response 400 Bad Request

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "id": "string",
    "type": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

{
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "errorMessage": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null,
    "components": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

GET /metrics

Response 200 OK

"string"
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "type": "string"
}

Response 400 Bad Request

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "id": "string",
    "type": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

{
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "errorMessage": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null,
    "components": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

Schemas

AggregatedHealth

Name Type
components Map_Health
status Status

Argument

Name Type
argument string
reason string

BadRequest

Name Type
errors Array<Argument>

Conflict

Name Type
reason string

DOWN

Forbidden

Name Type
reason string

Health

Name Type
status Status

InfoEndpointResponse

Name Type
buildTime string
gitCommit string
name string
sbtVersion string
scalaVersion string
version string

InternalServerError

Name Type
errorMessage string

Map_Health

NotFound

Name Type
id string
type string

Status

Type:

Unauthorized

Name Type
reason string

Unhealthy

Name Type
components Map_Health
status Status

UP