magpie.api.schemas

Module Contents

Classes

ServiceType_RequestPathSchema	Fundamental building block of schemas.
Service_RequestPathSchema	Fundamental building block of schemas.
Resource_RequestPathSchema	Fundamental building block of schemas.
ServiceResource_RequestPathSchema	Fundamental building block of schemas.
Permission_RequestPathSchema	Fundamental building block of schemas.
Group_RequestPathSchema	Fundamental building block of schemas.
User_RequestPathSchema	Fundamental building block of schemas.
UserGroup_RequestPathSchema	Fundamental building block of schemas.
GroupService_RequestPathSchema	Fundamental building block of schemas.
GroupServicePermission_RequestPathSchema	Fundamental building block of schemas.
GroupResource_RequestPathSchema	Fundamental building block of schemas.
GroupResourcePermission_RequestPathSchema	Fundamental building block of schemas.
UserService_RequestPathSchema	Fundamental building block of schemas.
UserServicePermission_RequestPathSchema	Fundamental building block of schemas.
UserResource_RequestPathSchema	Fundamental building block of schemas.
UserResourcePermission_RequestPathSchema	Fundamental building block of schemas.
Provider_RequestPathSchema	Fundamental building block of schemas.
TemporaryURL_RequestPathSchema	Fundamental building block of schemas.
AcceptType	Fundamental building block of schemas.
ContentType	Fundamental building block of schemas.
RequestHeaderSchemaAPI	Fundamental building block of schemas.
RequestHeaderSchemaUI	Fundamental building block of schemas.
QueryRequestSchemaAPI	Fundamental building block of schemas.
QueryEffectivePermissions	Fundamental building block of schemas.
QueryInheritGroupsPermissions	Fundamental building block of schemas.
QueryResolvedUserGroupsPermissions	Fundamental building block of schemas.
QueryFilterResources	Fundamental building block of schemas.
QueryParentResources	Fundamental building block of schemas.
QueryCascadeResourcesPermissions	Fundamental building block of schemas.
QueryFlattenServices	Fundamental building block of schemas.
QueryFilterServiceType	Fundamental building block of schemas.
PhoenixServicePushOption	Fundamental building block of schemas.
BaseRequestSchemaAPI	Fundamental building block of schemas.
HeaderResponseSchema	Fundamental building block of schemas.
BaseResponseSchemaAPI	Fundamental building block of schemas.
BaseResponseBodySchema	Fundamental building block of schemas.
ErrorVerifyParamConditions	Fundamental building block of schemas.
ErrorVerifyParamBodySchema	Fundamental building block of schemas.
ErrorFallbackBodySchema	Fundamental building block of schemas.
ErrorCallBodySchema	Fundamental building block of schemas.
ErrorResponseBodySchema	Fundamental building block of schemas.
InternalServerErrorResponseBodySchema	Fundamental building block of schemas.
BadRequestResponseSchema	Fundamental building block of schemas.
UnauthorizedResponseBodySchema	Fundamental building block of schemas.
UnauthorizedResponseSchema	Fundamental building block of schemas.
HTTPForbiddenResponseSchema	Fundamental building block of schemas.
NotFoundResponseSchema	Fundamental building block of schemas.
MethodNotAllowedResponseSchema	Fundamental building block of schemas.
NotAcceptableResponseSchema	Fundamental building block of schemas.
UnprocessableEntityResponseSchema	Fundamental building block of schemas.
InternalServerErrorResponseSchema	Fundamental building block of schemas.
ProvidersListSchema	Fundamental building block of schemas.
ResourceTypesListSchema	Fundamental building block of schemas.
ChildrenResourceTypesListSchema	Fundamental building block of schemas.
GroupNamesListSchema	Fundamental building block of schemas.
UserNamesListSchema	Fundamental building block of schemas.
Permission_Check_BadRequestResponseSchema	Fundamental building block of schemas.
PermissionObjectSchema	Fundamental building block of schemas.
PermissionObjectTypeSchema	Fundamental building block of schemas.
PermissionObjectListSchema	Fundamental building block of schemas.
PermissionNameListSchema	Fundamental building block of schemas.
PermissionPatchObjectSchema	Fundamental building block of schemas.
PermissionPatchListSchema	Fundamental building block of schemas.
Permissions_PATCH_RequestBodySchema	Fundamental building block of schemas.
Permissions_PATCH_RequestSchema	Fundamental building block of schemas.
Permissions_PATCH_OkResponseSchema	Fundamental building block of schemas.
Permissions_PATCH_BadRequestResponseSchema	Fundamental building block of schemas.
Permissions_PATCH_ForbiddenResponseSchema	Fundamental building block of schemas.
BaseUserInfoSchema	Fundamental building block of schemas.
PendingUserInfoSchema	Fundamental building block of schemas.
RegisteredUserInfoSchema	Fundamental building block of schemas.
UserBodySchema	Fundamental building block of schemas.
UserDetailListSchema	Fundamental building block of schemas.
GroupBaseBodySchema	Fundamental building block of schemas.
GroupPublicBodySchema	Fundamental building block of schemas.
GroupInfoBodySchema	Fundamental building block of schemas.
GroupDetailBodySchema	Fundamental building block of schemas.
ServiceConfigurationSchema	Fundamental building block of schemas.
ServiceSummarySchema	Fundamental building block of schemas.
ServiceBodySchema	Fundamental building block of schemas.
ServiceDetailSchema	Fundamental building block of schemas.
ResourceBodySchema	Fundamental building block of schemas.
Resource_ChildrenContainerWithoutChildResourceBodySchema	Fundamental building block of schemas.
Resource_ChildResourceWithoutChildrenBodySchema	Fundamental building block of schemas.
Resource_ParentResourceWithChildrenContainerBodySchema	Fundamental building block of schemas.
Resource_ChildrenContainerWithChildResourceBodySchema	Fundamental building block of schemas.
Resource_ChildResourceWithChildrenContainerBodySchema	Fundamental building block of schemas.
Resource_ServiceWithChildrenResourcesContainerBodySchema	Fundamental building block of schemas.
Resource_ServiceType_geoserverapi_SchemaNode	Fundamental building block of schemas.
Resource_ServiceType_ncwms_SchemaNode	Fundamental building block of schemas.
Resource_ServiceType_thredds_SchemaNode	Fundamental building block of schemas.
ResourcesSchemaNode	Fundamental building block of schemas.
Resources_ResponseBodySchema	Fundamental building block of schemas.
Resource_GET_RequestQuerySchema	Fundamental building block of schemas.
Resource_GET_RequestSchema	Fundamental building block of schemas.
Resource_MatchDictCheck_ForbiddenResponseSchema	Fundamental building block of schemas.
Resource_MatchDictCheck_NotFoundResponseSchema	Fundamental building block of schemas.
Resource_MatchDictCheck_BadRequestResponseSchema	Fundamental building block of schemas.
Resource_GET_ResponseBodySchema	Fundamental building block of schemas.
Resource_GET_OkResponseSchema	Fundamental building block of schemas.
Resource_GET_InternalServerErrorResponseSchema	Fundamental building block of schemas.
Resource_PATCH_RequestBodySchema	Fundamental building block of schemas.
Resource_PATCH_RequestSchema	Fundamental building block of schemas.
Resource_PATCH_ResponseBodySchema	Fundamental building block of schemas.
Resource_PATCH_OkResponseSchema	Fundamental building block of schemas.
Resource_PATCH_BadRequestResponseSchema	Fundamental building block of schemas.
Resource_PATCH_ForbiddenResponseSchema	Fundamental building block of schemas.
Resource_PATCH_ConflictResponseSchema	Fundamental building block of schemas.
Resource_DELETE_RequestBodySchema	Fundamental building block of schemas.
Resource_DELETE_RequestSchema	Fundamental building block of schemas.
Resource_DELETE_OkResponseSchema	Fundamental building block of schemas.
Resource_DELETE_ForbiddenResponseSchema	Fundamental building block of schemas.
Resources_GET_OkResponseSchema	Fundamental building block of schemas.
Resources_POST_RequestBodySchema	Fundamental building block of schemas.
Resources_POST_RequestSchema	Fundamental building block of schemas.
Resource_POST_ResponseBodySchema	Fundamental building block of schemas.
Resources_POST_CreatedResponseSchema	Fundamental building block of schemas.
Resources_POST_BadRequestResponseSchema	Fundamental building block of schemas.
Resources_POST_ForbiddenResponseSchema	Fundamental building block of schemas.
Resources_POST_NotFoundResponseSchema	Fundamental building block of schemas.
Resources_POST_ConflictResponseSchema	Fundamental building block of schemas.
ResourcePermissions_GET_RequestSchema	Fundamental building block of schemas.
ResourcePermissions_GET_ResponseBodySchema	Fundamental building block of schemas.
ResourcePermissions_GET_OkResponseSchema	Fundamental building block of schemas.
ResourcePermissions_GET_BadRequestResponseSchema	Fundamental building block of schemas.
ResourceTypes_GET_RequestSchema	Fundamental building block of schemas.
ResourceTypes_GET_ResponseBodySchema	Fundamental building block of schemas.
ResourceTypes_GET_OkResponseSchema	Fundamental building block of schemas.
ServiceResourcesBodySchema	Fundamental building block of schemas.
ServiceType_access_SchemaNode	Fundamental building block of schemas.
ServiceType_geoserverapi_SchemaNode	Fundamental building block of schemas.
ServiceType_geoserverwms_SchemaNode	Fundamental building block of schemas.
ServiceType_ncwms_SchemaNode	Fundamental building block of schemas.
ServiceType_projectapi_SchemaNode	Fundamental building block of schemas.
ServiceType_thredds_SchemaNode	Fundamental building block of schemas.
ServiceType_wfs_SchemaNode	Fundamental building block of schemas.
ServiceType_wps_SchemaNode	Fundamental building block of schemas.
ServiceTypesList	Fundamental building block of schemas.
ServiceListingQuerySchema	Fundamental building block of schemas.
ServiceTypes_GET_RequestSchema	Fundamental building block of schemas.
ServiceTypes_GET_OkResponseBodySchema	Fundamental building block of schemas.
ServiceTypes_GET_OkResponseSchema	Fundamental building block of schemas.
ServicesCategorizedSchemaNode	Fundamental building block of schemas.
Service_SummaryBodyResponseSchema	Fundamental building block of schemas.
Service_SuccessBodyResponseSchema	Fundamental building block of schemas.
Service_DetailBodyResponseSchema	Fundamental building block of schemas.
ServicesListingSchemaNode	Fundamental building block of schemas.
Service_MatchDictCheck_ForbiddenResponseSchema	Fundamental building block of schemas.
Service_MatchDictCheck_NotFoundResponseSchema	Fundamental building block of schemas.
Service_CheckConfig_UnprocessableEntityResponseSchema	Fundamental building block of schemas.
ServicesQuerySchema	Fundamental building block of schemas.
Services_GET_RequestSchema	Fundamental building block of schemas.
Service_GET_RequestSchema	Fundamental building block of schemas.
Service_GET_ResponseBodySchema	Fundamental building block of schemas.
Service_GET_OkResponseSchema	Fundamental building block of schemas.
Services_GET_ResponseBodySchema	Fundamental building block of schemas.
Services_GET_OkResponseSchema	Fundamental building block of schemas.
Services_GET_BadRequestResponseSchema	Fundamental building block of schemas.
Services_POST_BodySchema	Fundamental building block of schemas.
Services_POST_RequestBodySchema	Fundamental building block of schemas.
Services_POST_CreatedResponseBodySchema	Fundamental building block of schemas.
Services_POST_CreatedResponseSchema	Fundamental building block of schemas.
Services_POST_BadRequestResponseSchema	Fundamental building block of schemas.
Services_POST_Params_BadRequestResponseSchema	Fundamental building block of schemas.
Services_POST_ForbiddenResponseSchema	Fundamental building block of schemas.
Services_POST_ConflictResponseSchema	Fundamental building block of schemas.
Services_POST_UnprocessableEntityResponseSchema	Fundamental building block of schemas.
Services_POST_InternalServerErrorResponseSchema	Fundamental building block of schemas.
Service_PATCH_RequestBodySchema	Fundamental building block of schemas.
Service_PATCH_RequestSchema	Fundamental building block of schemas.
Service_PATCH_OkResponseSchema	Fundamental building block of schemas.
Service_PATCH_BadRequestResponseSchema	Fundamental building block of schemas.
Service_PATCH_ForbiddenResponseSchema_ReservedKeyword	Fundamental building block of schemas.
Service_PATCH_ForbiddenResponseSchema	Fundamental building block of schemas.
Service_PATCH_ConflictResponseSchema	Fundamental building block of schemas.
Service_PATCH_UnprocessableEntityResponseSchema	Fundamental building block of schemas.
Service_DELETE_RequestSchema	Fundamental building block of schemas.
Service_DELETE_OkResponseSchema	Fundamental building block of schemas.
Service_DELETE_ForbiddenResponseSchema	Fundamental building block of schemas.
ServicePermissions_ResponseBodySchema	Fundamental building block of schemas.
ServicePermissions_GET_OkResponseSchema	Fundamental building block of schemas.
ServicePermissions_GET_BadRequestResponseBodySchema	Fundamental building block of schemas.
ServicePermissions_GET_BadRequestResponseSchema	Fundamental building block of schemas.
ServiceResources_POST_RequestSchema	Fundamental building block of schemas.
ServiceResources_POST_ForbiddenResponseSchema	Fundamental building block of schemas.
ServiceResources_POST_UnprocessableEntityResponseSchema	Fundamental building block of schemas.
ServiceResource_GET_RequestSchema	Fundamental building block of schemas.
ServiceResource_DELETE_RequestSchema	Fundamental building block of schemas.
ServiceResources_GET_RequestSchema	Fundamental building block of schemas.
ServiceResources_GET_ResponseBodySchema	Fundamental building block of schemas.
ServiceResources_GET_OkResponseSchema	Fundamental building block of schemas.
ServiceTypeResources_GET_RequestSchema	Fundamental building block of schemas.
ResourceTypesAllowed	Fundamental building block of schemas.
ResourceTypeChildrenAllowed	Fundamental building block of schemas.
ResourceStructuresAllowed	Fundamental building block of schemas.
ServiceTypeResourceInfo	Fundamental building block of schemas.
ServiceTypeResourcesList	Fundamental building block of schemas.
ServiceTypeResources_GET_ResponseBodySchema	Fundamental building block of schemas.
ServiceTypeResources_GET_OkResponseSchema	Fundamental building block of schemas.
ServiceTypeResources_GET_ForbiddenResponseSchema	Fundamental building block of schemas.
ServiceTypeResources_GET_NotFoundResponseSchema	Fundamental building block of schemas.
ServiceTypeResourceTypes_GET_RequestSchema	Fundamental building block of schemas.
ServiceTypeResourceTypes_GET_ResponseBodySchema	Fundamental building block of schemas.
ServiceTypeResourceTypes_GET_OkResponseSchema	Fundamental building block of schemas.
ServiceTypeResourceTypes_GET_ForbiddenResponseSchema	Fundamental building block of schemas.
ServiceTypeResourceTypes_GET_NotFoundResponseSchema	Fundamental building block of schemas.
UsersQuery	Fundamental building block of schemas.
Users_GET_RequestSchema	Fundamental building block of schemas.
Users_GET_ResponseBodySchema	Fundamental building block of schemas.
Users_GET_OkResponseSchema	Fundamental building block of schemas.
Users_GET_BadRequestSchema	Fundamental building block of schemas.
Users_GET_ForbiddenResponseSchema	Fundamental building block of schemas.
Users_CheckInfo_UserNameValue_BadRequestResponseSchema	Fundamental building block of schemas.
Users_CheckInfo_UserNameValueExtraRegex_BadRequestResponseSchema	Fundamental building block of schemas.
Users_CheckInfo_UserNameSize_BadRequestResponseSchema	Fundamental building block of schemas.
Users_CheckInfo_Email_BadRequestResponseSchema	Fundamental building block of schemas.
Users_CheckInfo_PasswordValue_BadRequestResponseSchema	Fundamental building block of schemas.
Users_CheckInfo_PasswordSize_BadRequestResponseSchema	Fundamental building block of schemas.
Users_CheckInfo_GroupName_BadRequestResponseSchema	Fundamental building block of schemas.
Users_CheckInfo_ReservedKeyword_BadRequestResponseSchema	Fundamental building block of schemas.
User_Check_Status_BadRequestResponseSchema	Fundamental building block of schemas.
User_Check_ForbiddenResponseSchema	Fundamental building block of schemas.
User_Check_Name_ConflictResponseSchema	Fundamental building block of schemas.
User_Check_Email_ConflictResponseSchema	Fundamental building block of schemas.
User_POST_RequestBodySchema	Fundamental building block of schemas.
Users_POST_RequestSchema	Fundamental building block of schemas.
Users_POST_ResponseBodySchema	Fundamental building block of schemas.
Users_POST_CreatedResponseSchema	Fundamental building block of schemas.
Users_POST_ForbiddenResponseSchema	Fundamental building block of schemas.
UserNew_POST_ForbiddenResponseSchema	Fundamental building block of schemas.
User_PATCH_RequestBodySchema	Fundamental building block of schemas.
User_PATCH_RequestSchema	Fundamental building block of schemas.
Users_PATCH_OkResponseSchema	Fundamental building block of schemas.
User_PATCH_BadRequestResponseSchema	Fundamental building block of schemas.
User_PATCH_ForbiddenResponseSchema	Fundamental building block of schemas.
User_PATCH_ConflictResponseSchema	Fundamental building block of schemas.
User_GET_RequestSchema	Fundamental building block of schemas.
User_GET_ResponseBodySchema	Fundamental building block of schemas.
User_GET_OkResponseSchema	Fundamental building block of schemas.
User_CheckAnonymous_ForbiddenResponseSchema	Fundamental building block of schemas.
User_CheckAnonymous_NotFoundResponseSchema	Fundamental building block of schemas.
User_GET_ForbiddenResponseSchema	Fundamental building block of schemas.
User_GET_InternalServerErrorResponseSchema	Fundamental building block of schemas.
User_GET_NotFoundResponseSchema	Fundamental building block of schemas.
User_DELETE_RequestSchema	Fundamental building block of schemas.
User_DELETE_OkResponseSchema	Fundamental building block of schemas.
User_DELETE_ForbiddenResponseSchema	Fundamental building block of schemas.
UserGroup_Check_Status_BadRequestResponseSchema	Fundamental building block of schemas.
UserGroupsQuery	Fundamental building block of schemas.
UserGroups_GET_RequestSchema	Fundamental building block of schemas.
UserGroups_GET_ResponseBodySchema	Fundamental building block of schemas.
UserGroups_GET_OkResponseSchema	Fundamental building block of schemas.
UserGroups_POST_RequestBodySchema	Fundamental building block of schemas.
UserGroups_POST_RequestSchema	Fundamental building block of schemas.
UserGroups_POST_ResponseBodySchema	Fundamental building block of schemas.
UserGroups_POST_CreatedResponseSchema	Fundamental building block of schemas.
UserGroups_POST_AcceptedResponseSchema	Fundamental building block of schemas.
UserGroups_POST_GroupNotFoundResponseSchema	Fundamental building block of schemas.
UserGroups_POST_ForbiddenResponseSchema	Fundamental building block of schemas.
UserGroups_POST_RelationshipForbiddenResponseSchema	Fundamental building block of schemas.
UserGroups_POST_ConflictResponseBodySchema	Fundamental building block of schemas.
UserGroups_POST_ConflictResponseSchema	Fundamental building block of schemas.
UserGroup_Check_BadRequestResponseSchema	Fundamental building block of schemas.
UserGroup_GET_ForbiddenResponseSchema	Fundamental building block of schemas.
UserGroup_Check_NotFoundResponseSchema	Fundamental building block of schemas.
UserGroup_Check_ForbiddenResponseSchema	Fundamental building block of schemas.
UserGroup_DELETE_RequestSchema	Fundamental building block of schemas.
UserGroup_DELETE_OkResponseSchema	Fundamental building block of schemas.
UserGroup_DELETE_ForbiddenResponseSchema	Fundamental building block of schemas.
UserGroup_DELETE_NotFoundResponseSchema	Fundamental building block of schemas.
UserResources_GET_QuerySchema	Fundamental building block of schemas.
UserResources_GET_RequestSchema	Fundamental building block of schemas.
UserResources_GET_ResponseBodySchema	Fundamental building block of schemas.
UserResources_GET_OkResponseSchema	Fundamental building block of schemas.
UserResources_GET_NotFoundResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_Check_ParamResponseBodySchema	Fundamental building block of schemas.
UserResourcePermissions_Check_ErrorResponseBodySchema	Fundamental building block of schemas.
UserResourcePermissions_Check_ErrorResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_GET_QuerySchema	Fundamental building block of schemas.
UserResourcePermissions_GET_RequestSchema	Fundamental building block of schemas.
UserResourcePermissions_GET_ResponseBodySchema	Fundamental building block of schemas.
UserResourcePermissions_GET_OkResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_GET_BadRequestParamResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_GET_BadRequestResponseBodySchema	Fundamental building block of schemas.
UserResourcePermissions_GET_BadRequestRootServiceResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_GET_BadRequestResourceResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_GET_BadRequestResourceTypeResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_GET_NotFoundResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_POST_RequestBodySchema	Fundamental building block of schemas.
UserResourcePermissions_POST_RequestSchema	Fundamental building block of schemas.
UserResourcePermissions_POST_ResponseBodySchema	Fundamental building block of schemas.
UserResourcePermissions_POST_CreatedResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_POST_BadRequestResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_POST_ForbiddenResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_POST_ConflictResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_PUT_OkResponseSchema	Fundamental building block of schemas.
UserResourcePermissionName_DELETE_RequestSchema	Fundamental building block of schemas.
UserResourcePermissionName_DELETE_OkResponseSchema	Fundamental building block of schemas.
UserResourcePermissionName_DELETE_NotFoundResponseSchema	Fundamental building block of schemas.
UserResourcePermissions_DELETE_RequestBodySchema	Fundamental building block of schemas.
UserResourcePermissions_DELETE_RequestSchema	Fundamental building block of schemas.
UserServiceResources_GET_ResponseBodySchema	Fundamental building block of schemas.
UserServiceResources_GET_OkResponseSchema	Fundamental building block of schemas.
UserServiceResources_GET_QuerySchema	Fundamental building block of schemas.
UserServiceResources_GET_RequestSchema	Fundamental building block of schemas.
UserServicePermissions_POST_RequestBodySchema	Fundamental building block of schemas.
UserServicePermissions_POST_RequestSchema	Fundamental building block of schemas.
UserServicePermissions_DELETE_RequestBodySchema	Fundamental building block of schemas.
UserServicePermissions_DELETE_RequestSchema	Fundamental building block of schemas.
UserServicePermissionName_DELETE_RequestSchema	Fundamental building block of schemas.
UserServices_GET_QuerySchema	Fundamental building block of schemas.
UserServices_GET_RequestSchema	Fundamental building block of schemas.
UserServices_GET_ResponseBodySchema	Fundamental building block of schemas.
UserServices_GET_OkResponseSchema	Fundamental building block of schemas.
UserServicePermissions_GET_QuerySchema	Fundamental building block of schemas.
UserServicePermissions_GET_RequestSchema	Fundamental building block of schemas.
UserServicePermissions_GET_ResponseBodySchema	Fundamental building block of schemas.
UserServicePermissions_GET_OkResponseSchema	Fundamental building block of schemas.
UserServicePermissions_GET_NotFoundResponseSchema	Fundamental building block of schemas.
Group_MatchDictCheck_ForbiddenResponseSchema	Fundamental building block of schemas.
Group_MatchDictCheck_NotFoundResponseSchema	Fundamental building block of schemas.
Groups_CheckInfo_NotFoundResponseSchema	Fundamental building block of schemas.
Groups_CheckInfo_ForbiddenResponseSchema	Fundamental building block of schemas.
Groups_GET_ResponseBodySchema	Fundamental building block of schemas.
Groups_GET_OkResponseSchema	Fundamental building block of schemas.
Groups_GET_ForbiddenResponseSchema	Fundamental building block of schemas.
Groups_POST_RequestBodySchema	Fundamental building block of schemas.
Groups_POST_RequestSchema	Fundamental building block of schemas.
Groups_POST_ResponseBodySchema	Fundamental building block of schemas.
Groups_POST_CreatedResponseSchema	Fundamental building block of schemas.
Groups_POST_BadRequestResponseSchema	Fundamental building block of schemas.
Groups_POST_ForbiddenCreateResponseSchema	Fundamental building block of schemas.
Groups_POST_ForbiddenAddResponseSchema	Fundamental building block of schemas.
Groups_POST_ConflictResponseSchema	Fundamental building block of schemas.
Group_GET_RequestSchema	Fundamental building block of schemas.
Group_GET_ResponseBodySchema	Fundamental building block of schemas.
Group_GET_OkResponseSchema	Fundamental building block of schemas.
Group_GET_NotFoundResponseSchema	Fundamental building block of schemas.
Group_PATCH_RequestBodySchema	Fundamental building block of schemas.
Group_PATCH_RequestSchema	Fundamental building block of schemas.
Group_PATCH_OkResponseSchema	Fundamental building block of schemas.
Group_PATCH_None_BadRequestResponseSchema	Fundamental building block of schemas.
Group_PATCH_Name_BadRequestResponseSchema	Fundamental building block of schemas.
Group_PATCH_Size_BadRequestResponseSchema	Fundamental building block of schemas.
Group_PATCH_ReservedKeyword_ForbiddenResponseSchema	Fundamental building block of schemas.
Group_PATCH_ConflictResponseSchema	Fundamental building block of schemas.
Group_DELETE_RequestSchema	Fundamental building block of schemas.
Group_DELETE_OkResponseSchema	Fundamental building block of schemas.
Group_DELETE_ForbiddenResponseSchema	Fundamental building block of schemas.
Group_DELETE_ReservedKeyword_ForbiddenResponseSchema	Fundamental building block of schemas.
GroupUsers_GET_RequestSchema	Fundamental building block of schemas.
GroupUsers_GET_ResponseBodySchema	Fundamental building block of schemas.
GroupUsers_GET_OkResponseSchema	Fundamental building block of schemas.
GroupUsers_GET_ForbiddenResponseSchema	Fundamental building block of schemas.
GroupServices_GET_QuerySchema	Fundamental building block of schemas.
GroupServices_GET_RequestSchema	Fundamental building block of schemas.
GroupServices_GET_ResponseBodySchema	Fundamental building block of schemas.
GroupServices_GET_OkResponseSchema	Fundamental building block of schemas.
GroupServices_InternalServerErrorResponseBodySchema	Fundamental building block of schemas.
GroupServices_InternalServerErrorResponseSchema	Fundamental building block of schemas.
GroupServicePermissions_GET_RequestSchema	Fundamental building block of schemas.
GroupServicePermissions_GET_ResponseBodySchema	Fundamental building block of schemas.
GroupServicePermissions_GET_OkResponseSchema	Fundamental building block of schemas.
GroupServicePermissions_GET_InternalServerErrorResponseBodySchema	Fundamental building block of schemas.
GroupServicePermissions_GET_InternalServerErrorResponseSchema	Fundamental building block of schemas.
GroupServicePermissions_POST_RequestBodySchema	Fundamental building block of schemas.
GroupServicePermissions_POST_RequestSchema	Fundamental building block of schemas.
GroupResourcePermissions_POST_RequestSchema	Fundamental building block of schemas.
GroupResourcePermissions_Check_ResponseBodySchema	Fundamental building block of schemas.
GroupResourcePermissions_Check_ErrorResponseBodySchema	Fundamental building block of schemas.
GroupResourcePermissions_Check_ErrorResponseSchema	Fundamental building block of schemas.
GroupResourcePermissions_POST_CreatedResponseSchema	Fundamental building block of schemas.
GroupResourcePermissions_POST_ForbiddenAddResponseSchema	Fundamental building block of schemas.
GroupResourcePermissions_POST_ForbiddenCreateResponseSchema	Fundamental building block of schemas.
GroupResourcePermissions_POST_ForbiddenGetResponseSchema	Fundamental building block of schemas.
GroupResourcePermissions_POST_ConflictResponseSchema	Fundamental building block of schemas.
GroupResourcePermissions_PUT_OkResponseSchema	Fundamental building block of schemas.
GroupResourcePermissionName_DELETE_RequestSchema	Fundamental building block of schemas.
GroupResourcePermissions_DELETE_RequestBodySchema	Fundamental building block of schemas.
GroupResourcePermissions_DELETE_RequestSchema	Fundamental building block of schemas.
GroupResourcesPermissions_InternalServerErrorResponseBodySchema	Fundamental building block of schemas.
GroupResourcesPermissions_InternalServerErrorResponseSchema	Fundamental building block of schemas.
GroupResourcePermissions_InternalServerErrorResponseBodySchema	Fundamental building block of schemas.
GroupResourcePermissions_InternalServerErrorResponseSchema	Fundamental building block of schemas.
GroupResources_GET_QuerySchema	Fundamental building block of schemas.
GroupResources_GET_RequestSchema	Fundamental building block of schemas.
GroupResources_GET_ResponseBodySchema	Fundamental building block of schemas.
GroupResources_GET_OkResponseSchema	Fundamental building block of schemas.
GroupResources_GET_InternalServerErrorResponseBodySchema	Fundamental building block of schemas.
GroupResources_GET_InternalServerErrorResponseSchema	Fundamental building block of schemas.
GroupResourcePermissions_GET_RequestSchema	Fundamental building block of schemas.
GroupResourcePermissions_GET_ResponseBodySchema	Fundamental building block of schemas.
GroupResourcePermissions_GET_OkResponseSchema	Fundamental building block of schemas.
GroupServiceResources_GET_RequestSchema	Fundamental building block of schemas.
GroupServiceResources_GET_ResponseBodySchema	Fundamental building block of schemas.
GroupServiceResources_GET_OkResponseSchema	Fundamental building block of schemas.
GroupServicePermission_DELETE_RequestBodySchema	Fundamental building block of schemas.
GroupServicePermissionName_DELETE_RequestSchema	Fundamental building block of schemas.
GroupServicePermission_DELETE_ResponseBodySchema	Fundamental building block of schemas.
GroupServicePermission_DELETE_OkResponseSchema	Fundamental building block of schemas.
GroupServicePermission_DELETE_ForbiddenGetResponseSchema	Fundamental building block of schemas.
GroupServicePermission_DELETE_ForbiddenResponseSchema	Fundamental building block of schemas.
GroupServicePermission_DELETE_NotFoundResponseSchema	Fundamental building block of schemas.
RegisterGroup_NotFoundResponseSchema	Fundamental building block of schemas.
RegisterGroups_GET_ResponseBodySchema	Fundamental building block of schemas.
RegisterGroups_GET_OkResponseSchema	Fundamental building block of schemas.
RegisterGroups_GET_ForbiddenResponseSchema	Fundamental building block of schemas.
RegisterGroup_GET_RequestSchema	Fundamental building block of schemas.
RegisterGroup_GET_ResponseBodySchema	Fundamental building block of schemas.
RegisterGroup_GET_OkResponseSchema	Fundamental building block of schemas.
RegisterGroup_POST_RequestSchema	Fundamental building block of schemas.
RegisterGroup_POST_ResponseBodySchema	Fundamental building block of schemas.
RegisterGroup_POST_CreatedResponseSchema	Fundamental building block of schemas.
RegisterGroup_POST_ForbiddenResponseSchema	Fundamental building block of schemas.
RegisterGroup_POST_ConflictResponseSchema	Fundamental building block of schemas.
RegisterGroup_DELETE_RequestSchema	Fundamental building block of schemas.
RegisterGroup_DELETE_OkResponseSchema	Fundamental building block of schemas.
RegisterUsers_GET_RequestSchema	Fundamental building block of schemas.
RegisterUsers_GET_ResponseBodySchema	Fundamental building block of schemas.
RegisterUsers_GET_OkResponseSchema	Fundamental building block of schemas.
RegisterUsers_POST_RequestSchema	Fundamental building block of schemas.
RegisterUserBodySchema	Fundamental building block of schemas.
RegisterUsers_POST_ResponseBodySchema	Fundamental building block of schemas.
RegisterUsers_POST_CreatedResponseSchema	Fundamental building block of schemas.
RegisterUser_GET_RequestSchema	Fundamental building block of schemas.
RegisterUser_Check_NotFoundResponseSchema	Fundamental building block of schemas.
RegisterUser_Check_ConflictResponseSchema	Fundamental building block of schemas.
RegisterUser_GET_ResponseBodySchema	Fundamental building block of schemas.
RegisterUser_GET_OkResponseSchema	Fundamental building block of schemas.
RegisterUser_DELETE_RequestSchema	Fundamental building block of schemas.
RegisterUser_DELETE_OkResponseSchema	Fundamental building block of schemas.
TemporaryURL_GET_RequestSchema	Fundamental building block of schemas.
TemporaryURL_GET_OkResponseSchema	Fundamental building block of schemas.
TemporaryURL_GET_NotFoundResponseSchema	Fundamental building block of schemas.
TemporaryURL_GET_GoneResponseSchema	Fundamental building block of schemas.
TemporaryToken_POST_ForbiddenResponseSchema	Fundamental building block of schemas.
Session_GET_ResponseBodySchema	Fundamental building block of schemas.
Session_GET_OkResponseSchema	Fundamental building block of schemas.
Session_GET_InternalServerErrorResponseSchema	Fundamental building block of schemas.
ProvidersBodySchema	Fundamental building block of schemas.
Providers_GET_ResponseBodySchema	Fundamental building block of schemas.
Providers_GET_OkResponseSchema	Fundamental building block of schemas.
ProviderSignin_GET_RequestHeaderSchema	Fundamental building block of schemas.
ProviderSignin_GET_RequestSchema	Fundamental building block of schemas.
ProviderSignin_GET_FoundResponseBodySchema	Fundamental building block of schemas.
ProviderSignin_GET_FoundResponseSchema	Fundamental building block of schemas.
ProviderSignin_GET_BadRequestResponseBodySchema	Fundamental building block of schemas.
ProviderSignin_GET_BadRequestResponseSchema	Fundamental building block of schemas.
ProviderSignin_GET_UnauthorizedResponseSchema	Fundamental building block of schemas.
ProviderSignin_GET_ForbiddenResponseSchema	Fundamental building block of schemas.
ProviderSignin_GET_NotFoundResponseBodySchema	Fundamental building block of schemas.
ProviderSignin_GET_NotFoundResponseSchema	Fundamental building block of schemas.
Signin_BaseRequestSchema	Fundamental building block of schemas.
SigninQueryParamSchema	Fundamental building block of schemas.
Signin_GET_RequestSchema	Fundamental building block of schemas.
Signin_POST_RequestSchema	Fundamental building block of schemas.
Signin_POST_OkResponseSchema	Fundamental building block of schemas.
Signin_POST_BadRequestResponseSchema	Fundamental building block of schemas.
Signin_POST_UnauthorizedResponseSchema	Fundamental building block of schemas.
Signin_POST_ForbiddenResponseSchema	Fundamental building block of schemas.
Signin_POST_ConflictResponseSchema	Fundamental building block of schemas.
Signin_POST_InternalServerErrorBodySchema	Fundamental building block of schemas.
Signin_POST_Internal_InternalServerErrorResponseSchema	Fundamental building block of schemas.
Signin_POST_External_InternalServerErrorResponseSchema	Fundamental building block of schemas.
Signout_GET_OkResponseSchema	Fundamental building block of schemas.
Version_GET_ResponseBodySchema	Fundamental building block of schemas.
Version_GET_OkResponseSchema	Fundamental building block of schemas.
Homepage_GET_OkResponseSchema	Fundamental building block of schemas.
SwaggerAPI_GET_OkResponseSchema	Fundamental building block of schemas.

Functions

get_security(service, method)
service_api_route_info(→ Dict[magpie.typedefs.Str, Any])
generate_api_schema(→ magpie.typedefs.JSON)	Return JSON Swagger specifications of Magpie REST API.

Attributes

TitleAPI
InfoAPI
SecurityCookieAuthAPI
SecurityDefinitionsAPI
SecurityAuthenticatedAPI
SecurityAdministratorAPI
SecurityEveryoneAPI
_LOGGED_USER_VALUE
LoggedUserBase
SwaggerGenerator
SwaggerAPI
UsersAPI
UserAPI
UserGroupsAPI
UserGroupAPI
UserResourcesAPI
UserResourcePermissionsAPI
UserResourcePermissionAPI
UserServicesAPI
UserServiceAPI
UserServiceResourcesAPI
UserServicePermissionsAPI
UserServicePermissionAPI
LoggedUserAPI
LoggedUserGroupsAPI
LoggedUserGroupAPI
LoggedUserResourcesAPI
LoggedUserResourcePermissionAPI
LoggedUserResourcePermissionsAPI
LoggedUserServicesAPI
LoggedUserServiceResourcesAPI
LoggedUserServicePermissionsAPI
LoggedUserServicePermissionAPI
GroupsAPI
GroupAPI
GroupUsersAPI
GroupServicesAPI
GroupServicePermissionsAPI
GroupServicePermissionAPI
GroupServiceResourcesAPI
GroupResourcesAPI
GroupResourcePermissionsAPI
GroupResourcePermissionAPI
PermissionsAPI
RegisterGroupsAPI
RegisterGroupAPI
RegisterUsersAPI
RegisterUserAPI
ResourcesAPI
ResourceAPI
ResourcePermissionsAPI
ResourceTypesAPI
ServicesAPI
ServiceAPI
ServiceTypesAPI
ServiceTypeAPI
ServicePermissionsAPI
ServiceResourcesAPI
ServiceResourceAPI
ServiceTypeResourcesAPI
ServiceTypeResourceTypesAPI
ProvidersAPI
ProviderSigninAPI
SigninAPI
SignoutAPI
SessionAPI
VersionAPI
HomepageAPI
TemporaryUrlAPI
GroupNameParameter
UserNameParameter
ProviderNameParameter
PermissionNameParameter
ResourceIdParameter
ResourceTypeParameter
ServiceNameParameter
ServiceTypeParameter
TokenParameter
APITag
SessionTag
UsersTag
LoggedUserTag
GroupsTag
PermissionTag
RegisterTag
ResourcesTag
ServicesTag
TAG_DESCRIPTIONS
Service_DELETE_RequestBodySchema
ServiceResources_POST_CreatedResponseSchema
ServiceResources_POST_NotFoundResponseSchema
ServiceResources_POST_ConflictResponseSchema
ServiceResource_DELETE_ForbiddenResponseSchema
ServiceResource_DELETE_OkResponseSchema
User_Check_BadRequestResponseSchema
UserResourcePermissions_PUT_RequestSchema
UserResourcePermissions_PUT_CreatedResponseSchema
UserResourcePermissions_PUT_BadRequestResponseSchema
UserResourcePermissions_PUT_ForbiddenResponseSchema
UserResourcePermissionName_DELETE_ErrorResponseBodySchema
UserResourcePermissionName_DELETE_BadRequestResponseSchema
UserResourcePermissions_DELETE_OkResponseSchema
UserResourcePermissions_DELETE_BadRequestResponseSchema
UserResourcePermissions_DELETE_NotFoundResponseSchema
UserServicePermissions_PUT_RequestSchema
GroupResourcePermissions_PUT_RequestSchema
GroupResourcePermissions_PUT_CreatedResponseSchema
GroupResourcePermissions_PUT_ForbiddenResponseSchema
GroupServicePermissions_PUT_RequestSchema
GroupServicePermissions_DELETE_RequestSchema
RegisterGroup_DELETE_ForbiddenResponseSchema
RegisterGroup_DELETE_NotFoundResponseSchema
RegisterUsers_GET_ForbiddenResponseSchema
RegisterUser_Check_BadRequestResponseSchema
RegisterUsers_POST_ForbiddenResponseSchema
Resource_GET_responses
Resource_PATCH_responses
Resources_GET_responses
Resources_POST_responses
Resources_DELETE_responses
ResourcePermissions_GET_responses
ResourceTypes_GET_responses
ServiceTypes_GET_responses
ServiceType_GET_responses
Services_GET_responses
Services_POST_responses
Service_GET_responses
Service_PATCH_responses
Service_DELETE_responses
ServicePermissions_GET_responses
ServiceResources_GET_responses
ServiceResources_POST_responses
ServiceTypeResources_GET_responses
ServiceTypeResourceTypes_GET_responses
ServiceResource_GET_responses
ServiceResource_DELETE_responses
Permissions_PATCH_responses
Users_GET_responses
Users_POST_responses
User_GET_responses
User_PATCH_responses
User_DELETE_responses
UserResources_GET_responses
UserGroups_GET_responses
UserGroups_POST_responses
UserGroup_DELETE_responses
UserResourcePermissions_GET_responses
UserResourcePermissions_POST_responses
UserResourcePermissions_PUT_responses
UserResourcePermissions_DELETE_responses
UserResourcePermissionName_DELETE_responses
UserServices_GET_responses
UserServicePermissions_GET_responses
UserServiceResources_GET_responses
UserServicePermissions_POST_responses
UserServicePermissions_PUT_responses
UserServicePermissions_DELETE_responses
UserServicePermissionName_DELETE_responses
LoggedUser_GET_responses
LoggedUser_PATCH_responses
LoggedUser_DELETE_responses
LoggedUserResources_GET_responses
LoggedUserGroups_GET_responses
LoggedUserGroups_POST_responses
LoggedUserGroup_DELETE_responses
LoggedUserResourcePermissions_GET_responses
LoggedUserResourcePermissions_POST_responses
LoggedUserResourcePermissions_PUT_responses
LoggedUserResourcePermissions_DELETE_responses
LoggedUserResourcePermissionName_DELETE_responses
LoggedUserServices_GET_responses
LoggedUserServicePermissions_GET_responses
LoggedUserServiceResources_GET_responses
LoggedUserServicePermissions_POST_responses
LoggedUserServicePermissions_PUT_responses
LoggedUserServicePermissions_DELETE_responses
LoggedUserServicePermissionName_DELETE_responses
Groups_GET_responses
Groups_POST_responses
Group_GET_responses
Group_PATCH_responses
Group_DELETE_responses
GroupUsers_GET_responses
GroupServices_GET_responses
GroupServicePermissions_GET_responses
GroupServiceResources_GET_responses
GroupResourcePermissions_POST_responses
GroupServicePermissions_POST_responses
GroupResourcePermissions_PUT_responses
GroupServicePermissions_PUT_responses
GroupServicePermissionName_DELETE_responses
GroupServicePermissions_DELETE_responses
GroupResourcePermissions_DELETE_responses
GroupResourcePermissionName_DELETE_responses
GroupResources_GET_responses
GroupResourcePermissions_GET_responses
RegisterGroups_GET_responses
RegisterGroup_GET_responses
RegisterGroup_POST_responses
RegisterGroup_DELETE_responses
RegisterUsers_GET_responses
RegisterUsers_POST_responses
RegisterUser_GET_responses
RegisterUser_DELETE_responses
TemporaryURL_GET_responses
Providers_GET_responses
ProviderSignin_GET_responses
Signin_POST_responses
Signin_GET_responses
Signout_GET_responses
Session_GET_responses
Version_GET_responses
Homepage_GET_responses
SwaggerAPI_GET_responses

magpie.api.schemas.TitleAPI = 'Magpie REST API'

magpie.api.schemas.InfoAPI

magpie.api.schemas.SecurityCookieAuthAPI

magpie.api.schemas.SecurityDefinitionsAPI

magpie.api.schemas.SecurityAuthenticatedAPI

magpie.api.schemas.SecurityAdministratorAPI

magpie.api.schemas.SecurityEveryoneAPI

magpie.api.schemas.get_security(service, method)

magpie.api.schemas.service_api_route_info(service_api: cornice.Service, **kwargs: Any) → Dict[magpie.typedefs.Str, Any]

magpie.api.schemas._LOGGED_USER_VALUE

magpie.api.schemas.LoggedUserBase

magpie.api.schemas.SwaggerGenerator

magpie.api.schemas.SwaggerAPI

magpie.api.schemas.UsersAPI

magpie.api.schemas.UserAPI

magpie.api.schemas.UserGroupsAPI

magpie.api.schemas.UserGroupAPI

magpie.api.schemas.UserResourcesAPI

magpie.api.schemas.UserResourcePermissionsAPI

magpie.api.schemas.UserResourcePermissionAPI

magpie.api.schemas.UserServicesAPI

magpie.api.schemas.UserServiceAPI

magpie.api.schemas.UserServiceResourcesAPI

magpie.api.schemas.UserServicePermissionsAPI

magpie.api.schemas.UserServicePermissionAPI

magpie.api.schemas.LoggedUserAPI

magpie.api.schemas.LoggedUserGroupsAPI

magpie.api.schemas.LoggedUserGroupAPI

magpie.api.schemas.LoggedUserResourcesAPI

magpie.api.schemas.LoggedUserResourcePermissionAPI

magpie.api.schemas.LoggedUserResourcePermissionsAPI

magpie.api.schemas.LoggedUserServicesAPI

magpie.api.schemas.LoggedUserServiceResourcesAPI

magpie.api.schemas.LoggedUserServicePermissionsAPI

magpie.api.schemas.LoggedUserServicePermissionAPI

magpie.api.schemas.GroupsAPI

magpie.api.schemas.GroupAPI

magpie.api.schemas.GroupUsersAPI

magpie.api.schemas.GroupServicesAPI

magpie.api.schemas.GroupServicePermissionsAPI

magpie.api.schemas.GroupServicePermissionAPI

magpie.api.schemas.GroupServiceResourcesAPI

magpie.api.schemas.GroupResourcesAPI

magpie.api.schemas.GroupResourcePermissionsAPI

magpie.api.schemas.GroupResourcePermissionAPI

magpie.api.schemas.PermissionsAPI

magpie.api.schemas.RegisterGroupsAPI

magpie.api.schemas.RegisterGroupAPI

magpie.api.schemas.RegisterUsersAPI

magpie.api.schemas.RegisterUserAPI

magpie.api.schemas.ResourcesAPI

magpie.api.schemas.ResourceAPI

magpie.api.schemas.ResourcePermissionsAPI

magpie.api.schemas.ResourceTypesAPI

magpie.api.schemas.ServicesAPI

magpie.api.schemas.ServiceAPI

magpie.api.schemas.ServiceTypesAPI

magpie.api.schemas.ServiceTypeAPI

magpie.api.schemas.ServicePermissionsAPI

magpie.api.schemas.ServiceResourcesAPI

magpie.api.schemas.ServiceResourceAPI

magpie.api.schemas.ServiceTypeResourcesAPI

magpie.api.schemas.ServiceTypeResourceTypesAPI

magpie.api.schemas.ProvidersAPI

magpie.api.schemas.ProviderSigninAPI

magpie.api.schemas.SigninAPI

magpie.api.schemas.SignoutAPI

magpie.api.schemas.SessionAPI

magpie.api.schemas.VersionAPI

magpie.api.schemas.HomepageAPI

magpie.api.schemas.TemporaryUrlAPI

magpie.api.schemas.GroupNameParameter

magpie.api.schemas.UserNameParameter

magpie.api.schemas.ProviderNameParameter

magpie.api.schemas.PermissionNameParameter

magpie.api.schemas.ResourceIdParameter

magpie.api.schemas.ResourceTypeParameter

magpie.api.schemas.ServiceNameParameter

magpie.api.schemas.ServiceTypeParameter

magpie.api.schemas.TokenParameter

class magpie.api.schemas.ServiceType_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service_type

class magpie.api.schemas.Service_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service_name

class magpie.api.schemas.Resource_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_id

class magpie.api.schemas.ServiceResource_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service_name

resource_id

class magpie.api.schemas.Permission_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_name

class magpie.api.schemas.Group_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_name

class magpie.api.schemas.User_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

class magpie.api.schemas.UserGroup_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

group_name

class magpie.api.schemas.GroupService_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_name

service_name

class magpie.api.schemas.GroupServicePermission_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_name

service_name

permission_name

class magpie.api.schemas.GroupResource_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_name

resource_id

class magpie.api.schemas.GroupResourcePermission_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_name

resource_id

permission_name

class magpie.api.schemas.UserService_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

service_name

class magpie.api.schemas.UserServicePermission_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

service_name

permission_name

class magpie.api.schemas.UserResource_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

resource_id

class magpie.api.schemas.UserResourcePermission_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

resource_id

permission_name

class magpie.api.schemas.Provider_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

provider_name

class magpie.api.schemas.TemporaryURL_RequestPathSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

token

magpie.api.schemas.APITag = 'API'

magpie.api.schemas.SessionTag = 'Session'

magpie.api.schemas.UsersTag = 'User'

magpie.api.schemas.LoggedUserTag = 'Logged User'

magpie.api.schemas.GroupsTag = 'Group'

magpie.api.schemas.PermissionTag = 'Permission'

magpie.api.schemas.RegisterTag = 'Register'

magpie.api.schemas.ResourcesTag = 'Resource'

magpie.api.schemas.ServicesTag = 'Service'

magpie.api.schemas.TAG_DESCRIPTIONS

class magpie.api.schemas.AcceptType(*arg, **kw)

Bases: colander.SchemaNode

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

schema_type

default

example

missing

class magpie.api.schemas.ContentType(*arg, **kw)

Bases: colander.SchemaNode

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

schema_type

name = 'Content-Type'

default

example

missing

class magpie.api.schemas.RequestHeaderSchemaAPI(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

accept

content_type

class magpie.api.schemas.RequestHeaderSchemaUI(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

content_type

class magpie.api.schemas.QueryRequestSchemaAPI(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

format

class magpie.api.schemas.QueryEffectivePermissions(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

effective

class magpie.api.schemas.QueryInheritGroupsPermissions(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

inherit

class magpie.api.schemas.QueryResolvedUserGroupsPermissions(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resolve

class magpie.api.schemas.QueryFilterResources(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

filtered

class magpie.api.schemas.QueryParentResources(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

parents

flatten

invert

class magpie.api.schemas.QueryCascadeResourcesPermissions(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

cascade

class magpie.api.schemas.QueryFlattenServices(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

flatten

class magpie.api.schemas.QueryFilterServiceType(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

svc_type

class magpie.api.schemas.PhoenixServicePushOption(*arg, **kw)

Bases: colander.SchemaNode

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

schema_type

description = 'Push service update to Phoenix if applicable'

missing

default = False

class magpie.api.schemas.BaseRequestSchemaAPI(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

header

querystring

class magpie.api.schemas.HeaderResponseSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

content_type

class magpie.api.schemas.BaseResponseSchemaAPI(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

header

class magpie.api.schemas.BaseResponseBodySchema(code, description, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.ErrorVerifyParamConditions(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

not_none

not_empty

not_in

not_equal

is_none

is_empty

is_in

is_equal

is_true

is_false

is_type

matches

class magpie.api.schemas.ErrorVerifyParamBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

name

value

compare

conditions

class magpie.api.schemas.ErrorFallbackBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

exception

error

class magpie.api.schemas.ErrorCallBodySchema(*arg, **kw)

Bases: ErrorFallbackBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

detail

content

type

class magpie.api.schemas.ErrorResponseBodySchema(code: int, description: str, **kw: Any)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

route_name

request_url

method

param

call

fallback

class magpie.api.schemas.InternalServerErrorResponseBodySchema(**kw: Any)

Bases: ErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Required value for request is missing.'

body

class magpie.api.schemas.UnauthorizedResponseBodySchema(**kw: Any)

Bases: ErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

route_name

request_url

class magpie.api.schemas.UnauthorizedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Unauthorized access to this resource. Missing authentication headers or cookies.'

body

class magpie.api.schemas.HTTPForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Forbidden operation for this resource or insufficient user privileges.'

body

class magpie.api.schemas.NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'The route resource could not be found.'

body

class magpie.api.schemas.MethodNotAllowedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'The method is not allowed for this resource.'

body

class magpie.api.schemas.NotAcceptableResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Unsupported Content-Type in 'Accept' header was specified."

body

class magpie.api.schemas.UnprocessableEntityResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Invalid value specified.'

body

class magpie.api.schemas.InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Internal Server Error. Unhandled exception occurred.'

body

class magpie.api.schemas.ProvidersListSchema(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

provider_name

class magpie.api.schemas.ResourceTypesListSchema(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_type

class magpie.api.schemas.ChildrenResourceTypesListSchema(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_type

class magpie.api.schemas.GroupNamesListSchema(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_name

class magpie.api.schemas.UserNamesListSchema(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

class magpie.api.schemas.Permission_Check_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Invalid permission format. Must be a permission string name or detailed JSON object.'

body

class magpie.api.schemas.PermissionObjectSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

name

access

scope

class magpie.api.schemas.PermissionObjectTypeSchema(*arg, **kw)

Bases: PermissionObjectSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

type

reason

class magpie.api.schemas.PermissionObjectListSchema(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission

class magpie.api.schemas.PermissionNameListSchema(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_name

class magpie.api.schemas.PermissionPatchObjectSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_name

resource_type

user

group

permission

action

class magpie.api.schemas.PermissionPatchListSchema(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission

class magpie.api.schemas.Permissions_PATCH_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permissions

class magpie.api.schemas.Permissions_PATCH_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

body

class magpie.api.schemas.Permissions_PATCH_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Update permissions successful.'

body

class magpie.api.schemas.Permissions_PATCH_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Missing or invalid parameters for permissions update.'

body

class magpie.api.schemas.Permissions_PATCH_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to update requested permissions.'

body

class magpie.api.schemas.BaseUserInfoSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

email

status

class magpie.api.schemas.PendingUserInfoSchema(*arg, **kw)

Bases: BaseUserInfoSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

confirm_url

approve_url

decline_url

class magpie.api.schemas.RegisteredUserInfoSchema(*arg, **kw)

Bases: BaseUserInfoSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_id

class magpie.api.schemas.UserBodySchema(*arg, **kw)

Bases: RegisteredUserInfoSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_names

has_pending_group

class magpie.api.schemas.UserDetailListSchema(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user

class magpie.api.schemas.GroupBaseBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_name

class magpie.api.schemas.GroupPublicBodySchema(*arg, **kw)

Bases: GroupBaseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Publicly available group information.'

_description

class magpie.api.schemas.GroupInfoBodySchema(*arg, **kw)

Bases: GroupBaseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Minimal information returned by administrative API routes.'

group_id

class magpie.api.schemas.GroupDetailBodySchema(*arg, **kw)

Bases: GroupPublicBodySchema, GroupInfoBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Detailed information of the group obtained by specifically requesting it.'

terms

member_count

user_names

discoverable

priority

class magpie.api.schemas.ServiceConfigurationSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Custom configuration of the service. Expected format and fields specific to each service type....'

missing

default

class magpie.api.schemas.ServiceSummarySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_id

service_name

service_type

service_sync_type

service_configurable

public_url

service_url

class magpie.api.schemas.ServiceBodySchema(*arg, **kw)

Bases: ServiceSummarySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_names

permissions

class magpie.api.schemas.ServiceDetailSchema(*arg, **kw)

Bases: ServiceBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

configuration

class magpie.api.schemas.ResourceBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_id

resource_name

resource_display_name

resource_type

parent_id

root_service_id

permission_names

permissions

class magpie.api.schemas.Resource_ChildrenContainerWithoutChildResourceBodySchema(*arg, **kw)

Bases: ResourceBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

children

class magpie.api.schemas.Resource_ChildResourceWithoutChildrenBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

id

class magpie.api.schemas.Resource_ParentResourceWithChildrenContainerBodySchema(*arg, **kw)

Bases: ResourceBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

children

class magpie.api.schemas.Resource_ChildrenContainerWithChildResourceBodySchema(*arg, **kw)

Bases: ResourceBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

children

class magpie.api.schemas.Resource_ChildResourceWithChildrenContainerBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

id

class magpie.api.schemas.Resource_ServiceWithChildrenResourcesContainerBodySchema(*arg, **kw)

Bases: ServiceBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resources

class magpie.api.schemas.Resource_ServiceType_geoserverapi_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

geoserver_api

class magpie.api.schemas.Resource_ServiceType_ncwms_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

ncwms

class magpie.api.schemas.Resource_ServiceType_thredds_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

thredds

class magpie.api.schemas.ResourcesSchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

geoserver_api

ncwms

thredds

class magpie.api.schemas.Resources_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resources

class magpie.api.schemas.Resource_GET_RequestQuerySchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, QueryParentResources

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.Resource_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

querystring

class magpie.api.schemas.Resource_MatchDictCheck_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Resource query by id refused by db.'

body

class magpie.api.schemas.Resource_MatchDictCheck_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Resource ID not found.'

body

class magpie.api.schemas.Resource_MatchDictCheck_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Resource ID is an invalid literal for 'int' type."

body

class magpie.api.schemas.Resource_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource

class magpie.api.schemas.Resource_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get resource successful.'

body

class magpie.api.schemas.Resource_GET_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed building resource hierarchy into JSON formatted tree.'

body

class magpie.api.schemas.Resource_PATCH_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_name

service_push

class magpie.api.schemas.Resource_PATCH_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.Resource_PATCH_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_id

resource_name

old_resource_name

new_resource_name

class magpie.api.schemas.Resource_PATCH_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Update resource successful.'

body

class magpie.api.schemas.Resource_PATCH_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Cannot update resource with provided new name.'

body

class magpie.api.schemas.Resource_PATCH_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to update resource with new name.'

body

class magpie.api.schemas.Resource_PATCH_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Resource name already exists at requested tree level for update.'

body

class magpie.api.schemas.Resource_DELETE_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service_push

class magpie.api.schemas.Resource_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.Resource_DELETE_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete resource successful.'

body

class magpie.api.schemas.Resource_DELETE_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete resource from db failed.'

body

class magpie.api.schemas.Resources_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get resources successful.'

body

class magpie.api.schemas.Resources_POST_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_name

resource_display_name

resource_type

parent_id

class magpie.api.schemas.Resources_POST_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

body

class magpie.api.schemas.Resource_POST_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource

class magpie.api.schemas.Resources_POST_CreatedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Create resource successful.'

body

class magpie.api.schemas.Resources_POST_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid ['resource_name'|'resource_type'|'parent_id'] specified for child resource creation."

body

class magpie.api.schemas.Resources_POST_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to insert new resource in service tree using parent id.'

body

class magpie.api.schemas.Resources_POST_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Could not find specified resource parent id.'

body

class magpie.api.schemas.Resources_POST_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Resource name already exists at requested tree level for creation.'

body

class magpie.api.schemas.ResourcePermissions_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.ResourcePermissions_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_names

permissions

class magpie.api.schemas.ResourcePermissions_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get resource permissions successful.'

body

class magpie.api.schemas.ResourcePermissions_GET_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Invalid resource type to extract permissions.'

body

class magpie.api.schemas.ResourceTypes_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.ResourceTypes_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_name

resource_type

children_resource_types

children_resource_allowed

root_service_id

root_service_name

root_service_type

class magpie.api.schemas.ResourceTypes_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get applicable children resource types under resource successful.'

body

class magpie.api.schemas.ServiceResourcesBodySchema(*arg, **kw)

Bases: ServiceBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

children

class magpie.api.schemas.ServiceType_access_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

title = 'Services typed for Access'

description = 'These services are all-or-nothing root endpoint access.'

frontend

geoserver_web

magpie

class magpie.api.schemas.ServiceType_geoserverapi_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

name = 'geoserver-api'

title = 'Services typed for GeoServer-API'

geoserver_api

class magpie.api.schemas.ServiceType_geoserverwms_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

title = 'Services typed for GeoServer-WMS'

geoserverwms

class magpie.api.schemas.ServiceType_ncwms_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

title = 'Services typed for ncWMS2'

ncwms

class magpie.api.schemas.ServiceType_projectapi_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

name = 'project-api'

title = 'Services typed for Project-API'

project_api

class magpie.api.schemas.ServiceType_thredds_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

title = 'Services typed for Thredds'

thredds

class magpie.api.schemas.ServiceType_wfs_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

title = 'Services typed for WFS'

geoserver

class magpie.api.schemas.ServiceType_wps_SchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

title = 'Services typed for WPS'

lb_flyingpigeon

flyingpigeon

project

catalog

malleefowl

hummingbird

class magpie.api.schemas.ServiceTypesList(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service_type

class magpie.api.schemas.ServiceListingQuerySchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, QueryFlattenServices

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.ServiceTypes_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

querystring

class magpie.api.schemas.ServiceTypes_GET_OkResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service_types

class magpie.api.schemas.ServiceTypes_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get service types successful.'

body

class magpie.api.schemas.ServicesCategorizedSchemaNode(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description

access

geoserver_api

geoserverwms

ncwms

project_api

thredds

wfs

wps

class magpie.api.schemas.Service_SummaryBodyResponseSchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service

class magpie.api.schemas.Service_SuccessBodyResponseSchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service

class magpie.api.schemas.Service_DetailBodyResponseSchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service

class magpie.api.schemas.ServicesListingSchemaNode(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service

class magpie.api.schemas.Service_MatchDictCheck_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Service query by name refused by db.'

body

class magpie.api.schemas.Service_MatchDictCheck_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Service name not found.'

body

class magpie.api.schemas.Service_CheckConfig_UnprocessableEntityResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Service configuration must be formatted as JSON or null.'

body

class magpie.api.schemas.ServicesQuerySchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, QueryFlattenServices, QueryFilterServiceType

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.Services_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

querystring

class magpie.api.schemas.Service_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.Service_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service

class magpie.api.schemas.Service_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get service successful.'

body

class magpie.api.schemas.Services_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

services

class magpie.api.schemas.Services_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get services successful.'

body

class magpie.api.schemas.Services_GET_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'service_type' value does not correspond to any of the existing service types."

body

class magpie.api.schemas.Services_POST_BodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service_name

service_type

service_sync_type

service_url

configuration

class magpie.api.schemas.Services_POST_RequestBodySchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

body

class magpie.api.schemas.Services_POST_CreatedResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service

class magpie.api.schemas.Services_POST_CreatedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Service registration to db successful.'

body

class magpie.api.schemas.Services_POST_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'service_type' value does not correspond to any of the existing service types."

body

class magpie.api.schemas.Services_POST_Params_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Invalid parameter value for service creation.'

body

class magpie.api.schemas.Services_POST_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Service registration forbidden by db.'

body

class magpie.api.schemas.Services_POST_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Specified 'service_name' value already exists."

body

class magpie.api.schemas.Services_POST_UnprocessableEntityResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Service creation for registration failed.'

body

class magpie.api.schemas.Services_POST_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Service registration status could not be validated.'

body

class magpie.api.schemas.Service_PATCH_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'New parameters to apply for service update. Any combination of new values can be provided. At...'

service_name

service_url

service_push

configuration

class magpie.api.schemas.Service_PATCH_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.Service_PATCH_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Update service successful.'

body

class magpie.api.schemas.Service_PATCH_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Registered service values are already equal to update values.'

body

class magpie.api.schemas.Service_PATCH_ForbiddenResponseSchema_ReservedKeyword(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Update service name to 'types' not allowed (reserved keyword)."

body

class magpie.api.schemas.Service_PATCH_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Update service failed during value assignment.'

body

class magpie.api.schemas.Service_PATCH_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Specified 'service_name' already exists."

body

class magpie.api.schemas.Service_PATCH_UnprocessableEntityResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Specified value is in incorrectly or unsupported format.'

body

magpie.api.schemas.Service_DELETE_RequestBodySchema

class magpie.api.schemas.Service_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.Service_DELETE_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete service successful.'

body

class magpie.api.schemas.Service_DELETE_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete service from db refused by db.'

body

class magpie.api.schemas.ServicePermissions_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_names

permissions

class magpie.api.schemas.ServicePermissions_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get service permissions successful.'

path

body

class magpie.api.schemas.ServicePermissions_GET_BadRequestResponseBodySchema(code: int, description: str, **kw: Any)

Bases: ErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service

class magpie.api.schemas.ServicePermissions_GET_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Invalid service type specified by service.'

body

class magpie.api.schemas.ServiceResources_POST_RequestSchema(*arg, **kw)

Bases: Resources_POST_RequestSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

magpie.api.schemas.ServiceResources_POST_CreatedResponseSchema

magpie.api.schemas.ServiceResources_POST_NotFoundResponseSchema

magpie.api.schemas.ServiceResources_POST_ConflictResponseSchema

class magpie.api.schemas.ServiceResources_POST_ForbiddenResponseSchema(*arg, **kw)

Bases: Resources_POST_ForbiddenResponseSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'parent_id' specified for child resource creation under requested service."

class magpie.api.schemas.ServiceResources_POST_UnprocessableEntityResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Provided 'parent_id' value is invalid."

body

class magpie.api.schemas.ServiceResource_GET_RequestSchema(*arg, **kw)

Bases: Resource_GET_RequestSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service_name

class magpie.api.schemas.ServiceResource_DELETE_RequestSchema(*arg, **kw)

Bases: Resource_DELETE_RequestSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service_name

magpie.api.schemas.ServiceResource_DELETE_ForbiddenResponseSchema

magpie.api.schemas.ServiceResource_DELETE_OkResponseSchema

class magpie.api.schemas.ServiceResources_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.ServiceResources_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service_name

class magpie.api.schemas.ServiceResources_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get service resources successful.'

body

class magpie.api.schemas.ServiceTypeResources_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.ResourceTypesAllowed(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'List of all allowed resource types at some level within the service hierarchy.'

res_type_path

class magpie.api.schemas.ResourceTypeChildrenAllowed(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

title = 'ResourceTypeChildrenAllowed'

res_type

class magpie.api.schemas.ResourceStructuresAllowed(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Mapping of allowed combinations of nested resource type structures under the service. If...'

unknown = 'preserve'

res_type

class magpie.api.schemas.ServiceTypeResourceInfo(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_type

resource_child_allowed

resource_types_allowed

resource_structure_allowed

permission_names

permissions

class magpie.api.schemas.ServiceTypeResourcesList(*args, **kw)

Bases: colander.SequenceSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_type

class magpie.api.schemas.ServiceTypeResources_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_types

class magpie.api.schemas.ServiceTypeResources_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get service type resources successful.'

body

class magpie.api.schemas.ServiceTypeResources_GET_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to obtain resource types for specified service type.'

body

class magpie.api.schemas.ServiceTypeResources_GET_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'service_type' does not exist to obtain its resource types."

body

class magpie.api.schemas.ServiceTypeResourceTypes_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.ServiceTypeResourceTypes_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_types

class magpie.api.schemas.ServiceTypeResourceTypes_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get service type resource types successful.'

body

class magpie.api.schemas.ServiceTypeResourceTypes_GET_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to obtain resource types for specified service type.'

body

class magpie.api.schemas.ServiceTypeResourceTypes_GET_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'service_type' does not exist to obtain its resource types."

body

class magpie.api.schemas.UsersQuery(*arg, **kw)

Bases: QueryRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

status

detail

class magpie.api.schemas.Users_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

querystring

class magpie.api.schemas.Users_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_names

users

class magpie.api.schemas.Users_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get users successful.'

body

class magpie.api.schemas.Users_GET_BadRequestSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Invalid search parameter provided.'

body

class magpie.api.schemas.Users_GET_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get users query refused by db.'

body

class magpie.api.schemas.Users_CheckInfo_UserNameValue_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'user_name' value specified."

body

class magpie.api.schemas.Users_CheckInfo_UserNameValueExtraRegex_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'user_name' value specified. Does not match the extra user name regex."

body

class magpie.api.schemas.Users_CheckInfo_UserNameSize_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description

body

class magpie.api.schemas.Users_CheckInfo_Email_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'email' value specified."

body

class magpie.api.schemas.Users_CheckInfo_PasswordValue_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'password' value specified."

body

class magpie.api.schemas.Users_CheckInfo_PasswordSize_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description

body

class magpie.api.schemas.Users_CheckInfo_GroupName_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'group_name' value specified."

body

class magpie.api.schemas.Users_CheckInfo_ReservedKeyword_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'user_name' not allowed (reserved keyword)."

body

magpie.api.schemas.User_Check_BadRequestResponseSchema

class magpie.api.schemas.User_Check_Status_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'status' value specified."

body

class magpie.api.schemas.User_Check_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User check query was refused by db.'

body

class magpie.api.schemas.User_Check_Name_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User name matches an already existing user name.'

body

class magpie.api.schemas.User_Check_Email_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User email matches an already existing user email.'

body

class magpie.api.schemas.User_POST_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

email

password

group_name

class magpie.api.schemas.Users_POST_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

body

class magpie.api.schemas.Users_POST_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user

class magpie.api.schemas.Users_POST_CreatedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Add user to db successful.'

body

class magpie.api.schemas.Users_POST_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to add user to db.'

body

class magpie.api.schemas.UserNew_POST_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'New user query was refused by db.'

body

class magpie.api.schemas.User_PATCH_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

email

password

status

class magpie.api.schemas.User_PATCH_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.Users_PATCH_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Update user successful.'

body

class magpie.api.schemas.User_PATCH_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Missing parameters to update user or parameters do not provide any modification.'

body

class magpie.api.schemas.User_PATCH_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Targeted user update not allowed by requesting user.'

body

class magpie.api.schemas.User_PATCH_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'New name user already exists.'

body

class magpie.api.schemas.User_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.User_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user

class magpie.api.schemas.User_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get user successful.'

body

class magpie.api.schemas.User_CheckAnonymous_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Anonymous user refused for this operation.'

body

class magpie.api.schemas.User_CheckAnonymous_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Anonymous user not found.'

body

class magpie.api.schemas.User_GET_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User access forbidden for this resource.'

body

class magpie.api.schemas.User_GET_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User name query refused by db.'

body

class magpie.api.schemas.User_GET_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User name not found.'

body

class magpie.api.schemas.User_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.User_DELETE_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete user successful.'

body

class magpie.api.schemas.User_DELETE_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User could not be deleted.'

body

class magpie.api.schemas.UserGroup_Check_Status_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'status' value specified."

body

class magpie.api.schemas.UserGroupsQuery(*arg, **kw)

Bases: QueryRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

status

class magpie.api.schemas.UserGroups_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

querystring

class magpie.api.schemas.UserGroups_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_names

class magpie.api.schemas.UserGroups_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get user groups successful.'

body

class magpie.api.schemas.UserGroups_POST_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_name

class magpie.api.schemas.UserGroups_POST_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.UserGroups_POST_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

group_name

class magpie.api.schemas.UserGroups_POST_CreatedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Create user-group assignation successful. User is a member of the group.'

body

class magpie.api.schemas.UserGroups_POST_AcceptedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Accepted request to add user to the group. Group requires accepting terms and conditions....'

body

class magpie.api.schemas.UserGroups_POST_GroupNotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Cannot find the group to assign to.'

body

class magpie.api.schemas.UserGroups_POST_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Group query by name refused by db.'

body

class magpie.api.schemas.UserGroups_POST_RelationshipForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User-Group relationship creation refused by db.'

body

class magpie.api.schemas.UserGroups_POST_ConflictResponseBodySchema(code: int, description: str, **kw: Any)

Bases: ErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

param

user_name

group_name

class magpie.api.schemas.UserGroups_POST_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User already belongs to this group.'

body

class magpie.api.schemas.UserGroup_Check_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Invalid group name to associate to user.'

body

class magpie.api.schemas.UserGroup_GET_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Group query was refused by db.'

body

class magpie.api.schemas.UserGroup_Check_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Group for new user doesn't exist."

body

class magpie.api.schemas.UserGroup_Check_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to add user-group to db.'

body

class magpie.api.schemas.UserGroup_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

body

class magpie.api.schemas.UserGroup_DELETE_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete user-group successful. User is not a member of the group anymore.'

body

class magpie.api.schemas.UserGroup_DELETE_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete user-group relationship not permitted for this combination.'

body

class magpie.api.schemas.UserGroup_DELETE_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Could not remove user from group. Could not find any matching group membership for user.'

body

class magpie.api.schemas.UserResources_GET_QuerySchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, QueryInheritGroupsPermissions, QueryResolvedUserGroupsPermissions, QueryFilterResources, QueryFilterServiceType

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.UserResources_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

querystring

class magpie.api.schemas.UserResources_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resources

class magpie.api.schemas.UserResources_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get user resources successful.'

body

class magpie.api.schemas.UserResources_GET_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to populate user resources.'

body

class magpie.api.schemas.UserResourcePermissions_Check_ParamResponseBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

name

value

class magpie.api.schemas.UserResourcePermissions_Check_ErrorResponseBodySchema(code: int, description: str, **kw: Any)

Bases: ErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

resource_id

permission_name

permission

param

class magpie.api.schemas.UserResourcePermissions_Check_ErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Lookup of similar permission on service/resource for user refused by db.'

body

class magpie.api.schemas.UserResourcePermissions_GET_QuerySchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, QueryInheritGroupsPermissions, QueryResolvedUserGroupsPermissions, QueryEffectivePermissions

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.UserResourcePermissions_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

querystring

class magpie.api.schemas.UserResourcePermissions_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_names

permissions

class magpie.api.schemas.UserResourcePermissions_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get user resource permissions successful.'

body

class magpie.api.schemas.UserResourcePermissions_GET_BadRequestParamResponseSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

name

value

compare

class magpie.api.schemas.UserResourcePermissions_GET_BadRequestResponseBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

param

class magpie.api.schemas.UserResourcePermissions_GET_BadRequestRootServiceResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'resource' specified for resource permission retrieval."

body

class magpie.api.schemas.UserResourcePermissions_GET_BadRequestResourceResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'resource' specified for resource permission retrieval."

body

class magpie.api.schemas.UserResourcePermissions_GET_BadRequestResourceTypeResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'resource_type' for corresponding service resource permission retrieval."

body

class magpie.api.schemas.UserResourcePermissions_GET_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Specified user or resource not found to obtain permissions.'

body

class magpie.api.schemas.UserResourcePermissions_POST_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_name

permission

class magpie.api.schemas.UserResourcePermissions_POST_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

magpie.api.schemas.UserResourcePermissions_PUT_RequestSchema

class magpie.api.schemas.UserResourcePermissions_POST_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resource_id

user_id

permission_name

permission

class magpie.api.schemas.UserResourcePermissions_POST_CreatedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Create user resource permission successful.'

body

class magpie.api.schemas.UserResourcePermissions_POST_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Permission not allowed for specified 'resource_type'."

body

class magpie.api.schemas.UserResourcePermissions_POST_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Creation of permission on resource for user refused by db.'

body

class magpie.api.schemas.UserResourcePermissions_POST_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Similar permission already exist on resource for user.'

body

class magpie.api.schemas.UserResourcePermissions_PUT_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Update user resource permission successful.'

body

magpie.api.schemas.UserResourcePermissions_PUT_CreatedResponseSchema

magpie.api.schemas.UserResourcePermissions_PUT_BadRequestResponseSchema

magpie.api.schemas.UserResourcePermissions_PUT_ForbiddenResponseSchema

magpie.api.schemas.UserResourcePermissionName_DELETE_ErrorResponseBodySchema

magpie.api.schemas.UserResourcePermissionName_DELETE_BadRequestResponseSchema

class magpie.api.schemas.UserResourcePermissionName_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.UserResourcePermissionName_DELETE_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete user resource permission successful.'

body

class magpie.api.schemas.UserResourcePermissionName_DELETE_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Could not find user resource permission to delete from db.'

body

class magpie.api.schemas.UserResourcePermissions_DELETE_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission

class magpie.api.schemas.UserResourcePermissions_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

magpie.api.schemas.UserResourcePermissions_DELETE_OkResponseSchema

magpie.api.schemas.UserResourcePermissions_DELETE_BadRequestResponseSchema

magpie.api.schemas.UserResourcePermissions_DELETE_NotFoundResponseSchema

class magpie.api.schemas.UserServiceResources_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service

class magpie.api.schemas.UserServiceResources_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get user service resources successful.'

body

class magpie.api.schemas.UserServiceResources_GET_QuerySchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, QueryInheritGroupsPermissions, QueryResolvedUserGroupsPermissions

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.UserServiceResources_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

querystring

class magpie.api.schemas.UserServicePermissions_POST_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_name

permission

class magpie.api.schemas.UserServicePermissions_POST_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

magpie.api.schemas.UserServicePermissions_PUT_RequestSchema

class magpie.api.schemas.UserServicePermissions_DELETE_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission

class magpie.api.schemas.UserServicePermissions_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.UserServicePermissionName_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.UserServices_GET_QuerySchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, QueryCascadeResourcesPermissions, QueryInheritGroupsPermissions, QueryFlattenServices, QueryFilterServiceType

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.UserServices_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

querystring

class magpie.api.schemas.UserServices_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

services

class magpie.api.schemas.UserServices_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get user services successful.'

body

class magpie.api.schemas.UserServicePermissions_GET_QuerySchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, QueryInheritGroupsPermissions, QueryResolvedUserGroupsPermissions

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.UserServicePermissions_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

querystring

class magpie.api.schemas.UserServicePermissions_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_names

permissions

class magpie.api.schemas.UserServicePermissions_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get user service permissions successful.'

body

class magpie.api.schemas.UserServicePermissions_GET_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Could not find permissions using specified 'service_name' and 'user_name'."

body

class magpie.api.schemas.Group_MatchDictCheck_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Group query by name refused by db.'

body

class magpie.api.schemas.Group_MatchDictCheck_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Group name not found.'

body

class magpie.api.schemas.Groups_CheckInfo_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User name not found.'

body

class magpie.api.schemas.Groups_CheckInfo_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to obtain groups of user.'

body

class magpie.api.schemas.Groups_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_names

class magpie.api.schemas.Groups_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get groups successful.'

body

class magpie.api.schemas.Groups_GET_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Obtain group names refused by db.'

body

class magpie.api.schemas.Groups_POST_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_name

description

discoverable

terms

class magpie.api.schemas.Groups_POST_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

body

class magpie.api.schemas.Groups_POST_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group

class magpie.api.schemas.Groups_POST_CreatedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Create group successful.'

body

class magpie.api.schemas.Groups_POST_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Invalid parameter for group creation.'

body

class magpie.api.schemas.Groups_POST_ForbiddenCreateResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Create new group by name refused by db.'

body

class magpie.api.schemas.Groups_POST_ForbiddenAddResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Add new group by name refused by db.'

body

class magpie.api.schemas.Groups_POST_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Group name matches an already existing group name.'

body

class magpie.api.schemas.Group_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.Group_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group

class magpie.api.schemas.Group_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get group successful.'

body

class magpie.api.schemas.Group_GET_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Group name was not found.'

body

class magpie.api.schemas.Group_PATCH_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_name

description

discoverable

class magpie.api.schemas.Group_PATCH_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.Group_PATCH_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Update group successful.'

body

class magpie.api.schemas.Group_PATCH_None_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Missing new group parameters to update.'

body

class magpie.api.schemas.Group_PATCH_Name_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'group_name' value specified."

body

class magpie.api.schemas.Group_PATCH_Size_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description

body

class magpie.api.schemas.Group_PATCH_ReservedKeyword_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Update of reserved keyword or special group forbidden.'

body

class magpie.api.schemas.Group_PATCH_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Group name already exists.'

body

class magpie.api.schemas.Group_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.Group_DELETE_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete group successful.'

body

class magpie.api.schemas.Group_DELETE_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete group forbidden by db.'

body

class magpie.api.schemas.Group_DELETE_ReservedKeyword_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Deletion of reserved keyword or special group forbidden.'

body

class magpie.api.schemas.GroupUsers_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

querystring

class magpie.api.schemas.GroupUsers_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_names

class magpie.api.schemas.GroupUsers_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get group users successful.'

body

class magpie.api.schemas.GroupUsers_GET_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to obtain group user names from db.'

body

class magpie.api.schemas.GroupServices_GET_QuerySchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, QueryFilterServiceType

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.GroupServices_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

querystring

class magpie.api.schemas.GroupServices_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

services

class magpie.api.schemas.GroupServices_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get group services successful.'

body

class magpie.api.schemas.GroupServices_InternalServerErrorResponseBodySchema(**kw: Any)

Bases: InternalServerErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group

class magpie.api.schemas.GroupServices_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to populate group services.'

body

class magpie.api.schemas.GroupServicePermissions_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.GroupServicePermissions_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_names

permissions

class magpie.api.schemas.GroupServicePermissions_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get group service permissions successful.'

body

class magpie.api.schemas.GroupServicePermissions_GET_InternalServerErrorResponseBodySchema(**kw: Any)

Bases: InternalServerErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group

service

class magpie.api.schemas.GroupServicePermissions_GET_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to extract permissions names from group-service.'

body

class magpie.api.schemas.GroupServicePermissions_POST_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_name

permission

class magpie.api.schemas.GroupServicePermissions_POST_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.GroupResourcePermissions_POST_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.GroupResourcePermissions_Check_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_name

permission

resource

group

class magpie.api.schemas.GroupResourcePermissions_Check_ErrorResponseBodySchema(code: int, description: str, **kw: Any)

Bases: ErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.GroupResourcePermissions_Check_ErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Lookup of similar permission on service/resource for group refused by db.'

body

class magpie.api.schemas.GroupResourcePermissions_POST_CreatedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Create group resource permission successful.'

body

class magpie.api.schemas.GroupResourcePermissions_POST_ForbiddenAddResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Add group resource permission refused by db.'

body

class magpie.api.schemas.GroupResourcePermissions_POST_ForbiddenCreateResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Create group resource permission failed.'

body

class magpie.api.schemas.GroupResourcePermissions_POST_ForbiddenGetResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get group resource permission failed.'

body

class magpie.api.schemas.GroupResourcePermissions_POST_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Similar permission already exists on resource for group.'

body

magpie.api.schemas.GroupResourcePermissions_PUT_RequestSchema

magpie.api.schemas.GroupResourcePermissions_PUT_CreatedResponseSchema

magpie.api.schemas.GroupResourcePermissions_PUT_ForbiddenResponseSchema

class magpie.api.schemas.GroupResourcePermissions_PUT_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Update group resource permission successful.'

body

class magpie.api.schemas.GroupResourcePermissionName_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.GroupResourcePermissions_DELETE_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission

class magpie.api.schemas.GroupResourcePermissions_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.GroupResourcesPermissions_InternalServerErrorResponseBodySchema(**kw: Any)

Bases: InternalServerErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group

resource_ids

resource_types

class magpie.api.schemas.GroupResourcesPermissions_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to build group resources json tree.'

body

class magpie.api.schemas.GroupResourcePermissions_InternalServerErrorResponseBodySchema(**kw: Any)

Bases: InternalServerErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group

resource

class magpie.api.schemas.GroupResourcePermissions_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to obtain group resource permissions.'

body

class magpie.api.schemas.GroupResources_GET_QuerySchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, QueryFilterServiceType

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.GroupResources_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

querystring

class magpie.api.schemas.GroupResources_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

resources

class magpie.api.schemas.GroupResources_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get group resources successful.'

body

class magpie.api.schemas.GroupResources_GET_InternalServerErrorResponseBodySchema(**kw: Any)

Bases: InternalServerErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group

class magpie.api.schemas.GroupResources_GET_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to build group resources json tree.'

body

class magpie.api.schemas.GroupResourcePermissions_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.GroupResourcePermissions_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permissions_names

permissions

class magpie.api.schemas.GroupResourcePermissions_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get group resource permissions successful.'

body

class magpie.api.schemas.GroupServiceResources_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.GroupServiceResources_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

service

class magpie.api.schemas.GroupServiceResources_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get group service resources successful.'

body

magpie.api.schemas.GroupServicePermissions_PUT_RequestSchema

magpie.api.schemas.GroupServicePermissions_DELETE_RequestSchema

class magpie.api.schemas.GroupServicePermission_DELETE_RequestBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

permission_name

class magpie.api.schemas.GroupServicePermissionName_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.GroupServicePermission_DELETE_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group

resource

permission_name

permission

class magpie.api.schemas.GroupServicePermission_DELETE_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete group resource permission successful.'

body

class magpie.api.schemas.GroupServicePermission_DELETE_ForbiddenGetResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get group resource permission failed.'

body

class magpie.api.schemas.GroupServicePermission_DELETE_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete group resource permission refused by db.'

body

class magpie.api.schemas.GroupServicePermission_DELETE_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Permission not found for corresponding group and resource.'

body

class magpie.api.schemas.RegisterGroup_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Could not find any discoverable group matching provided name.'

body

class magpie.api.schemas.RegisterGroups_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group_names

class magpie.api.schemas.RegisterGroups_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get discoverable groups successful.'

body

class magpie.api.schemas.RegisterGroups_GET_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Obtain discoverable groups refused by db.'

body

class magpie.api.schemas.RegisterGroup_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.RegisterGroup_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

group

class magpie.api.schemas.RegisterGroup_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get discoverable group successful.'

body

class magpie.api.schemas.RegisterGroup_POST_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.RegisterGroup_POST_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

group_name

class magpie.api.schemas.RegisterGroup_POST_CreatedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Logged user successfully joined the discoverable group. User is now a member of the group.'

body

class magpie.api.schemas.RegisterGroup_POST_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Group membership was not permitted for the logged user.'

body

class magpie.api.schemas.RegisterGroup_POST_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Logged user is already a member of the group.'

body

class magpie.api.schemas.RegisterGroup_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.RegisterGroup_DELETE_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Logged user successfully removed from the group. User is not a member of the group anymore.'

body

magpie.api.schemas.RegisterGroup_DELETE_ForbiddenResponseSchema

magpie.api.schemas.RegisterGroup_DELETE_NotFoundResponseSchema

class magpie.api.schemas.RegisterUsers_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.RegisterUsers_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

registrations

class magpie.api.schemas.RegisterUsers_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get users pending registration successful.'

body

magpie.api.schemas.RegisterUsers_GET_ForbiddenResponseSchema

class magpie.api.schemas.RegisterUsers_POST_RequestSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

email

password

class magpie.api.schemas.RegisterUserBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

email

class magpie.api.schemas.RegisterUsers_POST_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

registration

class magpie.api.schemas.RegisterUsers_POST_CreatedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get users pending registration successful.'

body

magpie.api.schemas.RegisterUser_Check_BadRequestResponseSchema

magpie.api.schemas.RegisterUsers_POST_ForbiddenResponseSchema

class magpie.api.schemas.RegisterUser_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.RegisterUser_Check_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Pending user registration could not be found.'

body

class magpie.api.schemas.RegisterUser_Check_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'User registration is already pending approval.'

body

class magpie.api.schemas.RegisterUser_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

registration

class magpie.api.schemas.RegisterUser_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get pending user registration details successful.'

body

class magpie.api.schemas.RegisterUser_DELETE_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

body

class magpie.api.schemas.RegisterUser_DELETE_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Delete pending user registration successful.'

body

class magpie.api.schemas.TemporaryURL_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

class magpie.api.schemas.TemporaryURL_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Successful operation from provided temporary URL token.'

body

class magpie.api.schemas.TemporaryURL_GET_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Operation matching temporary URL token could not be found or was already processed.'

body

class magpie.api.schemas.TemporaryURL_GET_GoneResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Temporary URL token is expired.'

body

class magpie.api.schemas.TemporaryToken_POST_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to add token to db.'

body

class magpie.api.schemas.Session_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user

authenticated

class magpie.api.schemas.Session_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get session successful.'

body

class magpie.api.schemas.Session_GET_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Failed to get session details.'

body

class magpie.api.schemas.ProvidersBodySchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

internal

external

class magpie.api.schemas.Providers_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

providers

class magpie.api.schemas.Providers_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get providers successful.'

body

class magpie.api.schemas.ProviderSignin_GET_RequestHeaderSchema(*arg, **kw)

Bases: RequestHeaderSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

Authorization

HomepageRoute

class magpie.api.schemas.ProviderSignin_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

path

header

class magpie.api.schemas.ProviderSignin_GET_FoundResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

homepage_route

class magpie.api.schemas.ProviderSignin_GET_FoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "External login homepage route found. Temporary status before redirection to 'Homepage-Route' header."

body

class magpie.api.schemas.ProviderSignin_GET_BadRequestResponseBodySchema(code: int, description: str, **kw: Any)

Bases: ErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

reason

class magpie.api.schemas.ProviderSignin_GET_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Incorrectly formed 'Authorization: Bearer <access_token>' header."

body

class magpie.api.schemas.ProviderSignin_GET_UnauthorizedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Unauthorized 'UserInfo' update using provided Authorization headers."

body

class magpie.api.schemas.ProviderSignin_GET_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Forbidden 'Homepage-Route' host not matching Magpie refused for security reasons."

body

class magpie.api.schemas.ProviderSignin_GET_NotFoundResponseBodySchema(code: int, description: str, **kw: Any)

Bases: ErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

param

provider_name

providers

class magpie.api.schemas.ProviderSignin_GET_NotFoundResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = "Invalid 'provider_name' not found within available providers."

body

class magpie.api.schemas.Signin_BaseRequestSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

password

provider_name

class magpie.api.schemas.SigninQueryParamSchema(*arg, **kw)

Bases: QueryRequestSchemaAPI, Signin_BaseRequestSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

class magpie.api.schemas.Signin_GET_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

querystring

class magpie.api.schemas.Signin_POST_RequestSchema(*arg, **kw)

Bases: BaseRequestSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

body

class magpie.api.schemas.Signin_POST_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Login successful.'

body

class magpie.api.schemas.Signin_POST_BadRequestResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Missing credentials.'

body

class magpie.api.schemas.Signin_POST_UnauthorizedResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Incorrect credentials.'

body

class magpie.api.schemas.Signin_POST_ForbiddenResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Login was refused for this user.'

body

class magpie.api.schemas.Signin_POST_ConflictResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Add external user identity refused by db because it already exists.'

body

class magpie.api.schemas.Signin_POST_InternalServerErrorBodySchema(**kw: Any)

Bases: InternalServerErrorResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

user_name

provider_name

class magpie.api.schemas.Signin_POST_Internal_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Unknown login error.'

body

class magpie.api.schemas.Signin_POST_External_InternalServerErrorResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Error occurred while signing in with external provider.'

body

class magpie.api.schemas.Signout_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Sign out successful.'

body

class magpie.api.schemas.Version_GET_ResponseBodySchema(code, description, **kw)

Bases: BaseResponseBodySchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

version

db_version

class magpie.api.schemas.Version_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get version successful.'

body

class magpie.api.schemas.Homepage_GET_OkResponseSchema(*arg, **kw)

Bases: BaseResponseSchemaAPI

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description = 'Get homepage successful.'

body

class magpie.api.schemas.SwaggerAPI_GET_OkResponseSchema(*arg, **kw)

Bases: colander.MappingSchema

Fundamental building block of schemas.

The constructor accepts these positional arguments:

• typ: The ‘type’ for this node. It should be an instance of a class that implements the colander.interfaces.Type interface. If typ is not passed, a call to the schema_type() method on this class is made to get a default type. (When subclassing, schema_type() should be overridden to provide a reasonable default type).

• *children: a sequence of subnodes. If the subnodes of this node are not known at construction time, they can later be added via the add method.

The constructor accepts these keyword arguments:

• name: The name of this node.

• typ: The ‘type’ for this node can optionally be passed in as a keyword argument. See the documentation for the positional arg above.

• default: The default serialization value for this node when not set. If default is colander.drop, the node will be dropped from schema serialization. If not provided, the node will be serialized to colander.null.

• missing: The default deserialization value for this node. If it is not provided, the missing value of this node will be the special marker value colander.required, indicating that it is considered ‘required’. When missing is colander.required, the required computed attribute will be True. When missing is colander.drop, the node is dropped from the schema if it isn’t set during deserialization.

• missing_msg: Optional error message to be used if the value is required and missing.

• preparer: Optional preparer for this node. It should be an object that implements the colander.interfaces.Preparer interface.

• validator: Optional validator for this node. It should be an object that implements the colander.interfaces.Validator interface.

• after_bind: A callback which is called after a clone of this node has ‘bound’ all of its values successfully. This callback is useful for performing arbitrary actions to the cloned node, or direct children of the cloned node (such as removing or adding children) at bind time. A ‘binding’ is the result of an execution of the bind method of the clone’s prototype node, or one of the parents of the clone’s prototype nodes. The deepest nodes in the node tree are bound first, so the after_bind methods of the deepest nodes are called before the shallowest. The after_bind callback should accept two values: node and kw. node will be a clone of the bound node object, kw will be the set of keywords passed to the bind method.

• title: The title of this node. Defaults to a titleization of the name (underscores replaced with empty strings and the first letter of every resulting word capitalized). The title is used by higher-level systems (not by Colander itself).

• description: The description for this node. Defaults to '' (the empty string). The description is used by higher-level systems (not by Colander itself).

• widget: The ‘widget’ for this node. Defaults to None. The widget attribute is not interpreted by Colander itself, it is only meaningful to higher-level systems such as Deform.

• insert_before: if supplied, it names a sibling defined by a superclass for its parent node; the current node will be inserted before the named node. It is not useful unless a mapping schema is inherited from another mapping schema, and you need to control the ordering of the resulting nodes.

Arbitrary keyword arguments remaining will be attached to the node object unmolested.

description

header

body

magpie.api.schemas.Resource_GET_responses

magpie.api.schemas.Resource_PATCH_responses

magpie.api.schemas.Resources_GET_responses

magpie.api.schemas.Resources_POST_responses

magpie.api.schemas.Resources_DELETE_responses

magpie.api.schemas.ResourcePermissions_GET_responses

magpie.api.schemas.ResourceTypes_GET_responses

magpie.api.schemas.ServiceTypes_GET_responses

magpie.api.schemas.ServiceType_GET_responses

magpie.api.schemas.Services_GET_responses

magpie.api.schemas.Services_POST_responses

magpie.api.schemas.Service_GET_responses

magpie.api.schemas.Service_PATCH_responses

magpie.api.schemas.Service_DELETE_responses

magpie.api.schemas.ServicePermissions_GET_responses

magpie.api.schemas.ServiceResources_GET_responses

magpie.api.schemas.ServiceResources_POST_responses

magpie.api.schemas.ServiceTypeResources_GET_responses

magpie.api.schemas.ServiceTypeResourceTypes_GET_responses

magpie.api.schemas.ServiceResource_GET_responses

magpie.api.schemas.ServiceResource_DELETE_responses

magpie.api.schemas.Permissions_PATCH_responses

magpie.api.schemas.Users_GET_responses

magpie.api.schemas.Users_POST_responses

magpie.api.schemas.User_GET_responses

magpie.api.schemas.User_PATCH_responses

magpie.api.schemas.User_DELETE_responses

magpie.api.schemas.UserResources_GET_responses

magpie.api.schemas.UserGroups_GET_responses

magpie.api.schemas.UserGroups_POST_responses

magpie.api.schemas.UserGroup_DELETE_responses

magpie.api.schemas.UserResourcePermissions_GET_responses

magpie.api.schemas.UserResourcePermissions_POST_responses

magpie.api.schemas.UserResourcePermissions_PUT_responses

magpie.api.schemas.UserResourcePermissions_DELETE_responses

magpie.api.schemas.UserResourcePermissionName_DELETE_responses

magpie.api.schemas.UserServices_GET_responses

magpie.api.schemas.UserServicePermissions_GET_responses

magpie.api.schemas.UserServiceResources_GET_responses

magpie.api.schemas.UserServicePermissions_POST_responses

magpie.api.schemas.UserServicePermissions_PUT_responses

magpie.api.schemas.UserServicePermissions_DELETE_responses

magpie.api.schemas.UserServicePermissionName_DELETE_responses

magpie.api.schemas.LoggedUser_GET_responses

magpie.api.schemas.LoggedUser_PATCH_responses

magpie.api.schemas.LoggedUser_DELETE_responses

magpie.api.schemas.LoggedUserResources_GET_responses

magpie.api.schemas.LoggedUserGroups_GET_responses

magpie.api.schemas.LoggedUserGroups_POST_responses

magpie.api.schemas.LoggedUserGroup_DELETE_responses

magpie.api.schemas.LoggedUserResourcePermissions_GET_responses

magpie.api.schemas.LoggedUserResourcePermissions_POST_responses

magpie.api.schemas.LoggedUserResourcePermissions_PUT_responses

magpie.api.schemas.LoggedUserResourcePermissions_DELETE_responses

magpie.api.schemas.LoggedUserResourcePermissionName_DELETE_responses

magpie.api.schemas.LoggedUserServices_GET_responses

magpie.api.schemas.LoggedUserServicePermissions_GET_responses

magpie.api.schemas.LoggedUserServiceResources_GET_responses

magpie.api.schemas.LoggedUserServicePermissions_POST_responses

magpie.api.schemas.LoggedUserServicePermissions_PUT_responses

magpie.api.schemas.LoggedUserServicePermissions_DELETE_responses

magpie.api.schemas.LoggedUserServicePermissionName_DELETE_responses

magpie.api.schemas.Groups_GET_responses

magpie.api.schemas.Groups_POST_responses

magpie.api.schemas.Group_GET_responses

magpie.api.schemas.Group_PATCH_responses

magpie.api.schemas.Group_DELETE_responses

magpie.api.schemas.GroupUsers_GET_responses

magpie.api.schemas.GroupServices_GET_responses

magpie.api.schemas.GroupServicePermissions_GET_responses

magpie.api.schemas.GroupServiceResources_GET_responses

magpie.api.schemas.GroupResourcePermissions_POST_responses

magpie.api.schemas.GroupServicePermissions_POST_responses

magpie.api.schemas.GroupResourcePermissions_PUT_responses

magpie.api.schemas.GroupServicePermissions_PUT_responses

magpie.api.schemas.GroupServicePermissionName_DELETE_responses

magpie.api.schemas.GroupServicePermissions_DELETE_responses

magpie.api.schemas.GroupResourcePermissions_DELETE_responses

magpie.api.schemas.GroupResourcePermissionName_DELETE_responses

magpie.api.schemas.GroupResources_GET_responses

magpie.api.schemas.GroupResourcePermissions_GET_responses

magpie.api.schemas.RegisterGroups_GET_responses

magpie.api.schemas.RegisterGroup_GET_responses

magpie.api.schemas.RegisterGroup_POST_responses

magpie.api.schemas.RegisterGroup_DELETE_responses

magpie.api.schemas.RegisterUsers_GET_responses

magpie.api.schemas.RegisterUsers_POST_responses

magpie.api.schemas.RegisterUser_GET_responses

magpie.api.schemas.RegisterUser_DELETE_responses

magpie.api.schemas.TemporaryURL_GET_responses

magpie.api.schemas.Providers_GET_responses

magpie.api.schemas.ProviderSignin_GET_responses

magpie.api.schemas.Signin_POST_responses

magpie.api.schemas.Signin_GET_responses

magpie.api.schemas.Signout_GET_responses

magpie.api.schemas.Session_GET_responses

magpie.api.schemas.Version_GET_responses

magpie.api.schemas.Homepage_GET_responses

magpie.api.schemas.SwaggerAPI_GET_responses

magpie.api.schemas.generate_api_schema(swagger_base_spec: Dict[magpie.typedefs.Str, magpie.typedefs.Str | List[magpie.typedefs.Str]]) → magpie.typedefs.JSON

Return JSON Swagger specifications of Magpie REST API.

Uses Cornice Services and Schemas to return swagger specification.

Parameters:

swagger_base_spec – dictionary that specifies the ‘host’ and list of HTTP ‘schemes’ to employ.