httk.serve.optimade.engine.validate

Validate OPTIMADE paths, versions, and query parameters.

Attributes

FILTER_LENGTH_MAX

Functions

validate_optimade_request(request, version, schema[, ...])	Validate a raw request against an explicit served schema.
determine_optimade_version(request)	Determine the OPTIMADE version named by a request path.

Module Contents

httk.serve.optimade.engine.validate.FILTER_LENGTH_MAX = 4096

httk.serve.optimade.engine.validate.validate_optimade_request(request, version, schema, page_limit_max=50)

Validate a raw request against an explicit served schema.

Parameters:

• request (httk.serve.optimade.model.request.RawRequest) – Raw request supplied by the web layer.

• version (str) – API version selected for the request.

• schema (httk.serve.optimade.schema.served.ServedSchema) – Served entry and property schema.

• page_limit_max (int) – Largest accepted page_limit; larger requests raise 403.

Returns:

Canonical request and validated query parameters.

Raises:

httk.serve.optimade.model.errors.OptimadeError – If the path, version, or query is invalid.

Return type:

httk.serve.optimade.model.request.ValidatedRequest

httk.serve.optimade.engine.validate.determine_optimade_version(request)

Determine the OPTIMADE version named by a request path.

Parameters:

request (httk.serve.optimade.model.request.RawRequest) – Raw request whose relative path is inspected.

Returns:

Supported API version, using the default when unversioned.

Raises:

httk.serve.optimade.model.errors.OptimadeError – If the path names an unsupported version.

Return type:

str