QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-04-20 16:44:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(api): clean up API spec (#24838)

Browse Source
This commit is contained in:
Sebastian Liebscher
2023-07-31 19:03:58 +02:00
committed by GitHub
parent 5f103072b0
commit 14a27b1ba3
49 changed files with 402 additions and 426 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
superset/annotation_layers/annotations/api.py
View File

@@ -139,11 +139,10 @@ class AnnotationRestApi(BaseSupersetModelRestApi):
def get_list( # pylint: disable=arguments-differ
self, pk: int, **kwargs: Any
) -> Response:
"""Get a list of annotations
"""Get a list of annotations.
---
get:
description: >-
Get a list of annotations
summary: Get a list of annotations
parameters:
- in: path
schema:
@@ -200,11 +199,10 @@ class AnnotationRestApi(BaseSupersetModelRestApi):
def get( # pylint: disable=arguments-differ
self, pk: int, annotation_id: int, **kwargs: Any
) -> Response:
"""Get item from Model
"""Get item from model.
---
get:
description: >-
Get an item model
summary: Get an item model
parameters:
- in: path
schema:
@@ -256,11 +254,10 @@ class AnnotationRestApi(BaseSupersetModelRestApi):
@permission_name("post")
@requires_json
def post(self, pk: int) -> Response: # pylint: disable=arguments-differ
"""Creates a new Annotation
"""Create a new annotation.
---
post:
description: >-
Create a new Annotation
summary: Create a new annotation
parameters:
- in: path
schema:
@@ -326,11 +323,10 @@ class AnnotationRestApi(BaseSupersetModelRestApi):
def put( # pylint: disable=arguments-differ
self, pk: int, annotation_id: int
) -> Response:
"""Updates an Annotation
"""Update an annotation.
---
put:
description: >-
Update an annotation
summary: Update an annotation
parameters:
- in: path
schema:
@@ -400,11 +396,10 @@ class AnnotationRestApi(BaseSupersetModelRestApi):
def delete( # pylint: disable=arguments-differ
self, pk: int, annotation_id: int
) -> Response:
"""Deletes an Annotation
"""Delete an annotation.
---
delete:
description: >-
Delete an annotation
summary: Delete an annotation
parameters:
- in: path
schema:
@@ -453,11 +448,10 @@ class AnnotationRestApi(BaseSupersetModelRestApi):
@statsd_metrics
@rison(get_delete_ids_schema)
def bulk_delete(self, **kwargs: Any) -> Response:
"""Delete bulk Annotation layers
"""Bulk delete annotation layers.
---
delete:
description: >-
Deletes multiple annotation in a bulk operation.
summary: Bulk delete annotation layers
parameters:
- in: path
schema: