worldmonitor/docs/api/ImageryService.openapi.yaml at main · gavinlovespython/worldmonitor · GitHub

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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
openapi: 3.1.0
info:
    title: ImageryService API
    version: 1.0.0
paths:
    /api/imagery/v1/search-imagery:
        get:
            tags:
                - ImageryService
            summary: SearchImagery
            operationId: SearchImagery
            parameters:
                - name: bbox
                  in: query
                  required: false
                  schema:
                    type: string
                - name: datetime
                  in: query
                  required: false
                  schema:
                    type: string
                - name: source
                  in: query
                  required: false
                  schema:
                    type: string
                - name: limit
                  in: query
                  required: false
                  schema:
                    type: integer
                    format: int32
            responses:
                "200":
                    description: Successful response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/SearchImageryResponse'
                "400":
                    description: Validation error
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ValidationError'
                default:
                    description: Error response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/Error'
components:
    schemas:
        Error:
            type: object
            properties:
                message:
                    type: string
                    description: Error message (e.g., 'user not found', 'database connection failed')
            description: Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.
        FieldViolation:
            type: object
            properties:
                field:
                    type: string
                    description: The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key')
                description:
                    type: string
                    description: Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')
            required:
                - field
                - description
            description: FieldViolation describes a single validation error for a specific field.
        ValidationError:
            type: object
            properties:
                violations:
                    type: array
                    items:
                        $ref: '#/components/schemas/FieldViolation'
                    description: List of validation violations
            required:
                - violations
            description: ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.
        SearchImageryRequest:
            type: object
            properties:
                bbox:
                    type: string
                datetime:
                    type: string
                source:
                    type: string
                limit:
                    type: integer
                    format: int32
        SearchImageryResponse:
            type: object
            properties:
                scenes:
                    type: array
                    items:
                        $ref: '#/components/schemas/ImageryScene'
                totalResults:
                    type: integer
                    format: int32
                cacheHit:
                    type: boolean
        ImageryScene:
            type: object
            properties:
                id:
                    type: string
                satellite:
                    type: string
                datetime:
                    type: string
                resolutionM:
                    type: number
                    format: double
                mode:
                    type: string
                geometryGeojson:
                    type: string
                previewUrl:
                    type: string
                assetUrl:
                    type: string