summaryrefslogtreecommitdiff
path: root/archaeological_operations/views_api.py
blob: 3c66731e0ea96625d555ff190cd88d23acc76df5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
from ishtar_common.rest import SearchAPIView, FacetAPIView, GetAPIView, ExportAPIView
from archaeological_operations import models, forms


class FacetOperationAPIView(FacetAPIView):
    models = [models.Operation, models.ArchaeologicalSite]
    select_forms = [forms.OperationSelect, forms.SiteSelect]


class SearchOperationAPI(SearchAPIView):
    model = models.Operation


class SearchSiteAPI(SearchAPIView):
    model = models.ArchaeologicalSite


class ExportOperationAPI(ExportAPIView):
    model = models.Operation


class ExportSiteAPI(ExportAPIView):
    model = models.ArchaeologicalSite
    @extend_schema(
        # extra parameters added to the schema
        parameters=[
            OpenApiParameter(name='artist', description='Filter by artist', required=False, type=str),
            OpenApiParameter(
                name='release',
                type=OpenApiTypes.DATE,
                location=OpenApiParameter.QUERY,
                description='Filter by release date',
                examples=[
                    OpenApiExample(
                        'Example 1',
                        summary='short optional summary',
                        description='longer description',
                        value='1993-08-23'
                    ),
                    ...
                ],
            ),
        ],
    )


class GetOperationAPI(GetAPIView):
    model = models.Operation


class GetSiteAPI(GetAPIView):
    model = models.ArchaeologicalSite