dsp-ingest-maintenance v0.12.3

Servers

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

maintenance

POST /maintenance/{name}

Description

Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`httpAuth`	header	string	N/A	No	JWT Bearer token
`name`	path	None		No	The name of the action to be performed
`restrictToProjects`	query	array		No	Restrict the action to a list of projects, if no project is given apply the action to all projects.

Response 202 Accepted

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

{
    "title": "BadRequest",
    "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

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

Response 403 Forbidden

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

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "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

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

Response 409 Conflict

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

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "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

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

Response 503 Service Unavailable

application/json

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

POST /maintenance/create-originals/{shortcode}

Description

Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`httpAuth`	header	string	N/A	No	JWT Bearer token
`shortcode`	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Request body

application/json

[
    {
        "internalFilename": "string",
        "originalFilename": "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 request body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/MappingEntry"
    }
}

Response 202 Accepted

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

{
    "title": "BadRequest",
    "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

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

Response 403 Forbidden

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

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "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

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

Response 409 Conflict

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

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "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

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

Response 503 Service Unavailable

application/json

{
    "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 /maintenance/needs-top-left-correction

Description

Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`httpAuth`	header	string	N/A	No	JWT Bearer token

Response 202 Accepted

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

{
    "title": "BadRequest",
    "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

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

Response 403 Forbidden

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

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "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

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

Response 409 Conflict

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

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "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

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

Response 503 Service Unavailable

application/json

{
    "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 /maintenance/needs-originals

Description

Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`httpAuth`	header	string	N/A	No	JWT Bearer token
`imagesOnly`	query	boolean		No

Response 202 Accepted

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

{
    "title": "BadRequest",
    "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

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

Response 403 Forbidden

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

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "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

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

Response 409 Conflict

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

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "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

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

Response 503 Service Unavailable

application/json

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

ActionName

Type: string

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

InternalServerError

Name	Type
`errorMessage`	string

Map_Health

MappingEntry

Name	Type
`internalFilename`	string
`originalFilename`	string

NotFound

Name	Type
`id`	string
`type`	string

Status

Type:

Unauthorized

Name	Type
`reason`	string

Unhealthy

Name	Type
`components`	Map_Health
`status`	Status

UP

Security schemes

Name	Type	Scheme	Description
httpAuth	http	bearer