adhocracy_core.rest.schemas module

Data structures / validation specific to rest api requests.

validate_request_data(schema_class: object) → <built-in function callable>

Decorator for view to validate request with schema.

validate_visibility(view: <built-in function callable>)

Decorator for view to check if context is visible.

Raises:HTTPGone – if context is hidden and request method is GET, HEAD, or POST.

class UpdatedResourcesSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

List the resources affected by a transaction.

class ResourceResponseSchema(*arg, **kw)

Bases: adhocracy_core.schema.ResourcePathSchema

Data structure for responses of Resource requests.

class DELETEResourceResponseSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Data structure for Resource Delete requests.

class ItemResponseSchema(*arg, **kw)

Bases: adhocracy_core.rest.schemas.ResourceResponseSchema

Data structure for responses of IItem requests.

class GETResourceResponseSchema(*arg, **kw)

Bases: adhocracy_core.schema.ResourcePathAndContentSchema

Data structure for Resource GET requests.

class GETItemResponseSchema(*arg, **kw)

Bases: adhocracy_core.schema.ResourcePathAndContentSchema

Data structure for responses of IItem requests.

add_put_data_subschemas(node: adhocracy_core.schema.MappingSchema, kw: dict)

Add the resource sheet schemas that are ‘editable’.

class BlockExplanationResponseSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Data structure explaining a 410 Gone response.

class PUTResourceRequestSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Data structure for Resource PUT requests.

The subschemas for the Resource Sheets

add_post_data_subschemas(node: adhocracy_core.schema.SchemaNode, kw: dict)

Add the resource sheet schemas that are ‘creatable’.

class POSTResourceRequestSchema(*arg, **kw)

Bases: adhocracy_core.rest.schemas.PUTResourceRequestSchema

Data structure for Resource POST requests.

class AbsolutePaths(*args, **kw)

Bases: adhocracy_core.schema.SequenceSchema

List of resource paths.

validate_root_versions(node: adhocracy_core.schema.SchemaNode, value: list)

Validate root versions.

class POSTItemRequestSchema(*arg, **kw)

Bases: adhocracy_core.rest.schemas.POSTResourceRequestSchema

Data structure for Item and ItemVersion POST requests.

class POSTResourceRequestSchemaList(*args, **kw)

Bases: adhocracy_core.schema.SequenceSchema

Overview of POST request/response data structure.

class GETLocationMapping(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Overview of GET request/response data structure.

class PUTLocationMapping(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Overview of PUT request/response data structure.

class POSTLocationMapping(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Overview of POST request/response data structure.

class POSTLoginUsernameRequestSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Schema for login requests via username and password.

validator = <colander.deferred object>

create_validate_activation_path(context, request: pyramid.request.Request, registry: pyramid.registry.Registry) → <built-in function callable>

Validate the users activation path.

If valid and activated, the user object is added as ‘user’ to request.validated.

class POSTActivateAccountViewRequestSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Schema for account activation.

create_validate_login(context, request: pyramid.request.Request, registry: pyramid.registry.Registry, child_node_name: str)

Return validator to check the user identifier of a login request.

Parameters:child_node_name (str) – child node to get the login (email or name)

If valid, the user object is added as ‘user’ to request.validated.

create_validate_login_password(request: pyramid.request.Request, registry: pyramid.registry.Registry) → <built-in function callable>

Return validator to check the password of a login request.

Requires the user object as user in request.validated.

create_validate_account_active(request: pyramid.request.Request, child_node_name: str) → <built-in function callable>

Return validator to check the user account is already active.

Parameters:child_node_name (str) – The name of the child node to raise error.

Requires the user object as user in request.validated.

class POSTLoginEmailRequestSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Schema for login requests via email and password.

validator = <colander.deferred object>

class POSTReportAbuseViewRequestSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Schema for abuse reports.

interface MessageUserReference

Extends: adhocracy_core.interfaces.SheetToSheet

Dummy reference to validate user resources.

class POSTMessageUserViewRequestSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Schema for messages to a user.

class BatchHTTPMethod(*arg, **kw)

Bases: adhocracy_core.schema.SingleLine

An HTTP method in a batch request.

validator = <colander.OneOf object>

missing = <object object>

class BatchRequestPath(*arg, **kw)

Bases: adhocracy_core.schema.SingleLine

A path in a batch request.

Either a resource url or a preliminary resource path (a relative path preceded by ‘@’) or an absolute path.

Example values: '@item/v1‘, ‘http://a.org/adhocracy/item/v1‘, ‘/item/v1/’

default = ''

missing = <object object>

absolutpath = '/[a-zA-Z0-9\\_\\-\\.\\/]+'

preliminarypath = '[a-zA-Z0-9\\_\\-\\.\\/]+'

validator = <colander.All object>

class POSTBatchRequestItem(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

A single item in a batch request, encoding a single request.

path = None

A single item in a batch request, encoding a single request.

class POSTBatchRequestSchema(*args, **kw)

Bases: adhocracy_core.schema.SequenceSchema

Schema for batch requests (list of POSTBatchRequestItem’s).

class PoolElementsForm(*arg, **kw)

Bases: adhocracy_core.schema.SingleLine

The form of the elements attribute returned by the pool sheet.

validator = <colander.OneOf object>

missing = 'paths'

class PoolQueryDepth(*arg, **kw)

Bases: adhocracy_core.schema.Integer

The nesting depth of descendants in a pool response.

Either a positive number or the string ‘all’ to return descendants of arbitrary depth.

missing = <colander._drop object>

validator = <colander.Range object>

class GETPoolRequestSchema(*args, **kwargs)

Bases: adhocracy_core.schema.MappingSchema

GET parameters accepted for pool queries.

deserialize(cstruct=<colander.null>)

Deserialize the cstruct into an appstruct.

Adapt key/values to adhocracy_core.interfaces.SearchQuery. for BBB.

TODO: Change API according to internal SearchQuery api. refactor to follow coding guideline better.

add_arbitrary_filter_nodes(cstruct: dict, schema: adhocracy_core.rest.schemas.GETPoolRequestSchema, context: <InterfaceClass adhocracy_core.interfaces.IResource>, registry) → adhocracy_core.rest.schemas.GETPoolRequestSchema

Add schema nodes for arbitrary/references filters to schema.

class KeywordComparableSchema(*arg, **kw)

Bases: adhocracy_core.schema.SingleLine

SingleLine of KeywordComparable value.

validator = <colander.OneOf object>

class KeywordSequenceComparableSchema(*arg, **kw)

Bases: adhocracy_core.schema.SingleLine

SingleLine of KeywordSequenceComparable value.

validator = <colander.OneOf object>

class KeywordComparableSequenceBase(*arg, **kw)

Bases: adhocracy_core.schema.TupleSchema

Tuple with value KeywordSequenceComparable.

class KeywordComparableIntegers(*arg, **kw)

Bases: adhocracy_core.rest.schemas.KeywordComparableSequenceBase

Tuple with values KeywordSequenceComparable and Integers.

class KeywordComparableInterfaces(*arg, **kw)

Bases: adhocracy_core.rest.schemas.KeywordComparableSequenceBase

Tuple with values KeywordSequenceComparable and Interfaces.

class KeywordComparableSingleLines(*arg, **kw)

Bases: adhocracy_core.rest.schemas.KeywordComparableSequenceBase

Tuple with values KeywordSequenceComparable and SingleLines.

class KeywordComparableDateTimes(*arg, **kw)

Bases: adhocracy_core.rest.schemas.KeywordComparableSequenceBase

Tuple with values KeywordSequenceComparable and DateTimes.

class KeywordComparableBooleans(*arg, **kw)

Bases: adhocracy_core.rest.schemas.KeywordComparableSequenceBase

Tuple with values KeywordSequenceComparable and Booleans.

class KeywordComparableBase(*arg, **kw)

Bases: adhocracy_core.schema.TupleSchema

Tuple with value KeywordComparable.

class KeywordComparableInteger(*arg, **kw)

Bases: adhocracy_core.rest.schemas.KeywordComparableBase

Tuple with values KeywordComparable and Integer.

class KeywordComparableInterface(*arg, **kw)

Bases: adhocracy_core.rest.schemas.KeywordComparableBase

Tuple with values KeywordComparable and Interface.

class KeywordComparableSingleLine(*arg, **kw)

Bases: adhocracy_core.rest.schemas.KeywordComparableBase

Tuple with values KeywordComparable and SingleLine.

class KeywordComparableBoolean(*arg, **kw)

Bases: adhocracy_core.rest.schemas.KeywordComparableBase

Tuple with values KeywordComparable and Boolean.

class KeywordComparableDateTime(*arg, **kw)

Bases: adhocracy_core.rest.schemas.KeywordComparableBase

Tuple with values KeywordComparable and DateTime.

class FieldComparableSchema(*arg, **kw)

Bases: adhocracy_core.schema.SingleLine

SingleLine of FieldComparable value.

validator = <colander.OneOf object>

class FieldSequenceComparableSchema(*arg, **kw)

Bases: adhocracy_core.schema.SingleLine

SingleLine of FieldSequenceComparable value.

validator = <colander.OneOf object>

class FieldComparableSequenceBase(*arg, **kw)

Bases: adhocracy_core.schema.TupleSchema

Tuple with value FieldSequenceComparable.

class FieldComparableIntegers(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableSequenceBase

Tuple with values FieldSequenceComparable and Integers.

class FieldComparableFloats(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableSequenceBase

Tuple with values FieldSequenceComparable and Floats.

class FieldComparableInterfaces(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableSequenceBase

Tuple with values FieldSequenceComparable and Interfaces.

class FieldComparableSingleLines(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableSequenceBase

Tuple with values FieldSequenceComparable and SingleLines.

class FieldComparableDateTimes(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableSequenceBase

Tuple with values FieldSequenceComparable and DateTimes.

class FieldComparableBooleans(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableSequenceBase

Tuple with values FieldSequenceComparable and Booleans.

class FieldComparableBase(*arg, **kw)

Bases: adhocracy_core.schema.TupleSchema

Tuple with value FieldComparable.

class FieldComparableInteger(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableBase

Tuple with values FieldComparable and Integer.

class FieldComparableFloat(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableBase

Tuple with values FieldComparable and Float.

class FieldComparableInterface(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableBase

Tuple with values FieldComparable and Interface.

class FieldComparableSingleLine(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableBase

Tuple with values FieldComparable and SingleLine.

class FieldComparableBoolean(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableBase

Tuple with values FieldComparable and Boolean.

class FieldComparableDateTime(*arg, **kw)

Bases: adhocracy_core.rest.schemas.FieldComparableBase

Tuple with values FieldComparable and DateTime.

class POSTCreatePasswordResetRequestSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Schema to create a user password reset.

class POSTPasswordResetRequestSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Schema to get a user password reset resource.

class POSTLoginServiceKontoSchema(*arg, **kw)

Bases: adhocracy_core.schema.MappingSchema

Schema for login requests via service konto token.

validator = <colander.deferred object>

create_validate_service_konto_auth(context, request: pyramid.request.Request, registry: pyramid.registry.Registry)

Return validator that does the service konto token authentication.