dsp-ingest-monitoring v0.5.0-23-gcbbe7a6-dirty

Servers

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

monitoring

GET /info

Response 200 OK

application/json

{
    "name": "dsp-ingest",
    "version": "v0.5.0-23-gcbbe7a6-dirty",
    "scalaVersion": "3.3.3",
    "sbtVersion": "1.9.8",
    "buildTime": "2024-01-10 19:39:26.411+0100",
    "gitCommit": "cbbe7a6a06ba9dc64a6939ceb7880015a4c3fa9b"
}

Schema of the response body

{
    "required": [
        "name",
        "version",
        "scalaVersion",
        "sbtVersion",
        "buildTime",
        "gitCommit"
    ],
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "version": {
            "type": "string"
        },
        "scalaVersion": {
            "type": "string"
        },
        "sbtVersion": {
            "type": "string"
        },
        "buildTime": {
            "type": "string"
        },
        "gitCommit": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

application/json

{
    "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

{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "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

{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "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

{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "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

{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null
}

⚠️ 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

{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

GET /health

Response 200 OK

application/json

{
    "status": "UP"
}

Schema of the response body

{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

Response 400 Bad Request

application/json

{
    "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

{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "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

{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "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

{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "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

{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null
}

⚠️ 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

{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

GET /metrics

Response 200 OK

text/plain

"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

application/json

{
    "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

{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "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

{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "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

{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "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

{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null
}

⚠️ 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

{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

Schemas

Argument

Name	Type
`argument`	string
`reason`	string

BadRequest

Name	Type
`errors`	Array<Argument>

DOWN

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

NotFound

Name	Type
`id`	string
`type`	string

Status

Type:

Unauthorized

Name	Type
`reason`	string

Unhealthy

Name	Type
`status`	Status