magpie.api.management.resource.resource_views

Functions

get_resources_view(→ magpie.typedefs.AnyResponseType)

List all registered resources.

get_resource_handler(→ magpie.typedefs.AnyResponseType)

Obtains the resource specified by the request with all applicable parameter validation and handling.

get_resource_view(→ magpie.typedefs.AnyResponseType)

Get resource information.

create_resource_view(→ magpie.typedefs.AnyResponseType)

Register a new resource.

delete_resource_view(→ magpie.typedefs.AnyResponseType)

Unregister a resource.

update_resource(→ magpie.typedefs.AnyResponseType)

Update a resource information.

get_resource_permissions_view(...)

List all applicable permissions for a resource.

get_resource_types_view(→ magpie.typedefs.AnyResponseType)

List all applicable children resource types under another resource within a service hierarchy.

update_permissions(→ magpie.typedefs.AnyResponseType)

Update the requested permissions and create missing related resources if necessary.

Module Contents

magpie.api.management.resource.resource_views.get_resources_view(request: magpie.typedefs.AnyRequestType) magpie.typedefs.AnyResponseType[source]

List all registered resources.

magpie.api.management.resource.resource_views.get_resource_handler(request: magpie.typedefs.AnyRequestType) magpie.typedefs.AnyResponseType[source]

Obtains the resource specified by the request with all applicable parameter validation and handling.

magpie.api.management.resource.resource_views.get_resource_view(request: magpie.typedefs.AnyRequestType) magpie.typedefs.AnyResponseType[source]

Get resource information.

magpie.api.management.resource.resource_views.create_resource_view(request: magpie.typedefs.AnyRequestType) magpie.typedefs.AnyResponseType[source]

Register a new resource.

magpie.api.management.resource.resource_views.delete_resource_view(request: magpie.typedefs.AnyRequestType) magpie.typedefs.AnyResponseType[source]

Unregister a resource.

magpie.api.management.resource.resource_views.update_resource(request: magpie.typedefs.AnyRequestType) magpie.typedefs.AnyResponseType[source]

Update a resource information.

magpie.api.management.resource.resource_views.get_resource_permissions_view(request: magpie.typedefs.AnyRequestType) magpie.typedefs.AnyResponseType[source]

List all applicable permissions for a resource.

magpie.api.management.resource.resource_views.get_resource_types_view(request: magpie.typedefs.AnyRequestType) magpie.typedefs.AnyResponseType[source]

List all applicable children resource types under another resource within a service hierarchy.

magpie.api.management.resource.resource_views.update_permissions(request: magpie.typedefs.AnyRequestType) magpie.typedefs.AnyResponseType[source]

Update the requested permissions and create missing related resources if necessary.