1swagger: '2.0'
2basePath: /v1
3info:
4 version: experimental
5 title: Planet Mosaics API
6 description: An API to interact with Mosaics generated on Planet's platform.
7consumes:
8 - application/json
9produces:
10 - application/json
11schemes:
12 - https
13
14definitions:
15 MosaicSeriesFilter:
16 properties:
17 filterType:
18 type: string
19 filterable:
20 type: string
21 enum:
22 - mosaic_name
23 default: mosaic_name
24 value:
25 type: string
26 required:
27 - filterType
28 - filterable
29
30 Error:
31 properties:
32 message:
33 description: A descriptive error message.
34 type: string
35 type: object
36
37 Errors:
38 description: A list of Errors
39 type: array
40 items:
41 $ref: '#/definitions/Error'
42
43 APIError:
44 description: An APIError communicates both general and field-specific errors.
45 General errors include issues with core API usage as well as conflicts that
46 involve more than one field. Field-specific errors correspond to an individual
47 query parameter or request body attribute. Errors referencing nested fields
48 will be dot-delimited (e.g. user.groups.0.name).
49 properties:
50 field:
51 additionalProperties:
52 $ref: '#/definitions/Errors'
53 type: object
54 general:
55 $ref: '#/definitions/Errors'
56 required:
57 - general
58 - field
59 type: object
60
61 WriteResponse:
62 type: object
63 required:
64 - ok
65 description: Response of requests to create a mosaic
66 properties:
67 ok:
68 description: If it was successfully created.
69 type: boolean
70 errors:
71 description: A list of validation errors which prevented the request from succeeding
72 items:
73 $ref: '#/definitions/APIError'
74 type: array
75 id:
76 description: The id of the newly created mosaic
77 type: string
78
79 Mosaic:
80 description: A Mosaic is an object that includes the core metadata for a mosaic that is published on the platform. A Mosaic object may have additional fields depending on its `product_type`.
81 properties:
82 _links:
83 $ref: '#/definitions/MosaicLinks'
84 id:
85 description: A UUID to uniquely identify this Mosaic.
86 format: uuid
87 type: string
88 renditions:
89 description: A list of renditions to consume the Mosaic data.
90 items:
91 $ref: '#/definitions/MosaicRendition'
92 type: array
93 bbox:
94 description: The bounding box representing the extent of the mosaic.
95 format: geojson
96 type: string
97 coordinate_system:
98 description: The coordinate system of this mosaic
99 type: string
100 first_acquired:
101 description: The acquisition date of the oldest scene that contributed to this mosaic.
102 type: string
103 format: date-time
104 last_acquired:
105 description: The acquisition date of the newest scene that contributed to this mosaic.
106 type: string
107 format: date-time
108 interval:
109 description: The interval of the mosaic
110 type: string
111 product_type:
112 description: The product type of this mosaics, currently supported is "timelapse", "basemap"
113 type: string
114 name:
115 description: A name for this mosaic. This does not need to be unique.
116 type: string
117 type: object
118 required:
119 - id
120 - renditions
121 - bbox
122 - coordinate_system
123 - first_acquired
124 - last_acquired
125 - product_type
126 - name
127
128 MosaicSeries:
129 description: A Mosaic Series is a container to group mosaics that follow that have a specific criteria. This can be likened to a filter on top of mosaics, where a series can be defined as a TOI/AOI on a set Timelapse Mosaics.
130 type: object
131 properties:
132 _links:
133 $ref: '#/definitions/MosaicSeriesLinks'
134 id:
135 description: A UUID to uniquely identify this Mosaic Series.
136 format: uuid
137 type: string
138 name:
139 description: A human readable name for this series
140 type: string
141 interval:
142 description: The interval for the mosaics in the series.
143 type: string
144 product_type:
145 description: The type of product this mosaic is
146 enum:
147 - basemap
148 timelapse
149 l3m
150 type: string
151 selection_filters:
152 type: array
153 description: An array of MosaicSeriesFilters to filter mosaics
154 items:
155 $ref: '#/definitions/MosaicSeriesFilter'
156 required:
157 - id
158 - _links
159 - product_type
160 - name
161
162 MosaicRendition:
163 type: object
164 properties:
165 name:
166 description: The name of this rendition, e.g. RGB
167 type: string
168 type:
169 description: The type of this rendition, e.g. planet::webtiles::xyz, planet::webtiles::wmts
170 type: string
171 location:
172 description: A URL (possibly a template) pointing to a resource that provides access to the rendition.
173 type: string
174
175 MosaicListLinks:
176 properties:
177 _self:
178 description: The link back to this list page
179 type: string
180 type: object
181
182 MosaicSeriesListLinks:
183 properties:
184 _self:
185 description: The link to this listing page
186 type: string
187 type: object
188
189 MosaicLinks:
190 properties:
191 _self:
192 description: The canonical link to this specific Mosaic
193 type: string
194 type: object
195
196 MosaicSeriesLinks:
197 properties:
198 _self:
199 description: The canonincal link to this specific Mosaic Series
200 type: string
201 mosaics:
202 description: The canonincal link to the mosaics inside this Mosaic Series
203 type: string
204 type: object
205
206 MosaicSeriesMosaicsLinks:
207 properties:
208 _self:
209 description: The canonical link back to this list
210 type: string
211 type: object
212
213 MosaicListPage:
214 properties:
215 _links:
216 $ref: '#/definitions/MosaicListLinks'
217 mosaics:
218 items:
219 $ref: '#/definitions/Mosaic'
220 type: array
221 type: object
222
223 MosaicSeriesListPage:
224 properties:
225 _links:
226 $ref: '#/definitions/MosaicSeriesListLinks'
227 series:
228 items:
229 $ref: '#/definitions/MosaicSeries'
230 type: array
231 type: object
232
233 MosaicSeriesMosaicsListPage:
234 properties:
235 _links:
236 $ref: '#/definitions/MosaicSeriesMosaicsLinks'
237 mosaics:
238 items:
239 $ref: '#/definitions/Mosaic'
240 type: array
241 type: object
242
243parameters:
244 pSeriesId:
245 description: The Mosaic Series ID
246 in: path
247 name: SeriesId
248 format: uuid
249 required: true
250 type: string
251
252paths:
253 /mosaic/experimental/mosaics:
254 post:
255 description: Creates a new mosaic
256 parameters:
257 - name: body
258 in: body
259 description: mosaic to add
260 required: true
261 schema:
262 $ref: '#/definitions/Mosaic'
263 responses:
264 200:
265 description: Mosaic was successfully created
266 schema:
267 $ref: '#/definitions/WriteResponse'
268 400:
269 description: There was a validation error
270 schema:
271 $ref: '#/definitions/APIError'
272 put:
273 description: updates a mosaic
274 responses:
275 200:
276 description: Mosaic was successfully updated
277 schema:
278 $ref: '#/definitions/WriteResponse'
279 400:
280 description: There was a validation error
281 schema:
282 $ref: '#/definitions/APIError'
283 get:
284 description: Returns all accessible mosaics. For non authenticated users, this returns public mosaics.
285 responses:
286 200:
287 description: A list of mosaics.
288 schema:
289 $ref: '#/definitions/MosaicListPage'
290 400:
291 description: There was an error with the request.
292 schema:
293 $ref: '#/definitions/APIError'
294
295 /mosaic/experimental/series:
296 post:
297 description: Creates a Series
298 responses:
299 200:
300 description: The series was created.
301 schema:
302 $ref: '#/definitions/WriteResponse'
303 400:
304 description: There was an error with the request
305 schema:
306 $ref: '#/definitions/APIError'
307 get:
308 description: Returns a list of accessible mosaic series
309 responses:
310 200:
311 description: A list of Mosaic Series
312 schema:
313 $ref: '#/definitions/MosaicSeriesListPage'
314 400:
315 description: There was an error with the request.
316 schema:
317 $ref: '#/definitions/APIError'
318
319 /mosaic/experimental/series/{SeriesId}:
320 get:
321 description: Returns back a single Mosaic Series Record
322 parameters:
323 - $ref: '#/parameters/pSeriesId'
324 responses:
325 200:
326 description: Gets a single Mosaic Series record.
327 schema:
328 $ref: '#/definitions/MosaicSeries'
329 400:
330 description: There was an error with the request.
331 schema:
332 $ref: '#/definitions/APIError'
333
334 /mosaic/experimental/series/{SeriesId}/mosaics:
335 get:
336 description: Returns the list of mosaics in this series.
337 parameters:
338 - $ref: '#/parameters/pSeriesId'
339 responses:
340 200:
341 description: Returns the list of mosaics in this series.
342 schema:
343 $ref: '#/definitions/MosaicSeriesMosaicsListPage'
344 400:
345 description: There was an error with the request.
346 schema:
347 $ref: '#/definitions/APIError'
View as plain text