class AnnotationLayerRestApi(BaseSupersetModelRestApi):
datamodel = SQLAInterface(AnnotationLayer)
include_route_methods = RouteMethod.REST_MODEL_VIEW_CRUD_SET | {
RouteMethod.RELATED,
"bulk_delete", # not using RouteMethod since locally defined
}
class_permission_name = "Annotation"
method_permission_name = MODEL_API_RW_METHOD_PERMISSION_MAP
resource_name = "annotation_layer"
allow_browser_login = True
show_columns = [
"id",
"name",
"descr",
]
list_columns = [
"id",
"name",
"descr",
"created_by.first_name",
"created_by.last_name",
"changed_by.first_name",
"changed_by.last_name",
"changed_on",
"changed_on_delta_humanized",
"created_on",
]
add_columns = ["name", "descr"]
edit_columns = add_columns
add_model_schema = AnnotationLayerPostSchema()
edit_model_schema = AnnotationLayerPutSchema()
order_columns = [
"name",
"descr",
"created_by.first_name",
"changed_by.first_name",
"changed_on",
"changed_on_delta_humanized",
"created_on",
]
search_filters = {"name": [AnnotationLayerAllTextFilter]}
allowed_rel_fields = {"created_by"}
apispec_parameter_schemas = {
"get_delete_ids_schema": get_delete_ids_schema,
}
openapi_spec_tag = "Annotation Layers"
openapi_spec_methods = openapi_spec_methods_override
@expose("/<int:pk>", methods=["DELETE"])
@protect()
@safe
@statsd_metrics
@event_logger.log_this_with_context(
action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.delete",
log_to_statsd=False,
)
@permission_name("delete")
def delete(self, pk: int) -> Response:
"""Delete an annotation layer
---
delete:
description: >-
Delete an annotation layer
parameters:
- in: path
schema:
type: integer
name: pk
description: The annotation layer pk for this annotation
responses:
200:
description: Item deleted
content:
application/json:
schema:
type: object
properties:
message:
type: string
404:
$ref: '#/components/responses/404'
422:
$ref: '#/components/responses/422'
500:
$ref: '#/components/responses/500'
"""
try:
DeleteAnnotationLayerCommand(g.user, pk).run()
return self.response(200, message="OK")
except AnnotationLayerNotFoundError:
return self.response_404()
except AnnotationLayerDeleteIntegrityError as ex:
return self.response_422(message=str(ex))
except AnnotationLayerDeleteFailedError as ex:
logger.error(
"Error deleting annotation layer %s: %s",
self.__class__.__name__,
str(ex),
exc_info=True,
)
return self.response_422(message=str(ex))
@expose("/", methods=["POST"])
@protect()
@safe
@statsd_metrics
@permission_name("post")
@event_logger.log_this_with_context(
action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.post",
log_to_statsd=False,
)
def post(self) -> Response:
"""Creates a new Annotation Layer
---
post:
description: >-
Create a new Annotation
requestBody:
description: Annotation Layer schema
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/{{self.__class__.__name__}}.post'
responses:
201:
description: Annotation added
content:
application/json:
schema:
type: object
properties:
id:
type: number
result:
$ref: '#/components/schemas/{{self.__class__.__name__}}.post'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
"""
if not request.is_json:
return self.response_400(message="Request is not JSON")
try:
item = self.add_model_schema.load(request.json)
# This validates custom Schema with custom validations
except ValidationError as error:
return self.response_400(message=error.messages)
try:
new_model = CreateAnnotationLayerCommand(g.user, item).run()
return self.response(201, id=new_model.id, result=item)
except AnnotationLayerNotFoundError as ex:
return self.response_400(message=str(ex))
except AnnotationLayerInvalidError as ex:
return self.response_422(message=ex.normalized_messages())
except AnnotationLayerCreateFailedError as ex:
logger.error(
"Error creating annotation %s: %s",
self.__class__.__name__,
str(ex),
exc_info=True,
)
return self.response_422(message=str(ex))
@expose("/<int:pk>", methods=["PUT"])
@protect()
@safe
@statsd_metrics
@permission_name("put")
@event_logger.log_this_with_context(
action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.put",
log_to_statsd=False,
)
def put(self, pk: int) -> Response:
"""Updates an Annotation Layer
---
put:
description: >-
Update an annotation layer
parameters:
- in: path
schema:
type: integer
name: pk
description: The annotation layer pk for this annotation
requestBody:
description: Annotation schema
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/{{self.__class__.__name__}}.put'
responses:
200:
description: Annotation changed
content:
application/json:
schema:
type: object
properties:
id:
type: number
result:
$ref: '#/components/schemas/{{self.__class__.__name__}}.put'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
"""
if not request.is_json:
return self.response_400(message="Request is not JSON")
try:
item = self.edit_model_schema.load(request.json)
item["layer"] = pk
# This validates custom Schema with custom validations
except ValidationError as error:
return self.response_400(message=error.messages)
try:
new_model = UpdateAnnotationLayerCommand(g.user, pk, item).run()
return self.response(200, id=new_model.id, result=item)
except AnnotationLayerNotFoundError:
return self.response_404()
except AnnotationLayerInvalidError as ex:
return self.response_422(message=ex.normalized_messages())
except AnnotationLayerUpdateFailedError as ex:
logger.error(
"Error updating annotation %s: %s",
self.__class__.__name__,
str(ex),
exc_info=True,
)
return self.response_422(message=str(ex))
@expose("/", methods=["DELETE"])
@protect()
@safe
@statsd_metrics
@rison(get_delete_ids_schema)
@event_logger.log_this_with_context(
action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.bulk_delete",
log_to_statsd=False,
)
def bulk_delete(self, **kwargs: Any) -> Response:
"""Delete bulk Annotation layers
---
delete:
description: >-
Deletes multiple annotation layers in a bulk operation.
parameters:
- in: query
name: q
content:
application/json:
schema:
$ref: '#/components/schemas/get_delete_ids_schema'
responses:
200:
description: CSS templates bulk delete
content:
application/json:
schema:
type: object
properties:
message:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
422:
$ref: '#/components/responses/422'
500:
$ref: '#/components/responses/500'
"""
item_ids = kwargs["rison"]
try:
BulkDeleteAnnotationLayerCommand(g.user, item_ids).run()
return self.response(
200,
message=ngettext(
"Deleted %(num)d annotation layer",
"Deleted %(num)d annotation layers",
num=len(item_ids),
),
)
except AnnotationLayerNotFoundError:
return self.response_404()
except AnnotationLayerBulkDeleteIntegrityError as ex:
return self.response_422(message=str(ex))
except AnnotationLayerBulkDeleteFailedError as ex:
return self.response_422(message=str(ex))
def test_annotation_layer_post_schema_empty():
with pytest.raises(ValidationError):
AnnotationLayerPostSchema().load({})
def test_annotation_layer_post_schema_with_name_and_descr():
result = AnnotationLayerPostSchema().load({"name": "foo", "descr": "bar"})
assert result["name"] == "foo"
assert result["descr"] == "bar"
def test_annotation_layer_post_schema_with_null_name():
with pytest.raises(ValidationError):
AnnotationLayerPostSchema().load({"name": None})
def test_annotation_layer_post_schema_with_name():
result = AnnotationLayerPostSchema().load({"name": "foo"})
assert result["name"] == "foo"
assert "descr" not in result