-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"openapi":"3.0.2","info":{"title":"stac-fastapi","description":"stac-fastapi","version":"0.1"},"paths":{"/":{"get":{"summary":"Landing Page","description":"Endpoint.","operationId":"Landing_Page__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/conformance":{"get":{"summary":"Conformance Classes","description":"Endpoint.","operationId":"Conformance_Classes_conformance_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/collections/{collection_id}/items/{item_id}":{"get":{"summary":"Get Item","description":"Endpoint.","operationId":"Get_Item_collections__collection_id__items__item_id__get","parameters":[{"description":"Collection ID","required":true,"schema":{"title":"Collection Id","type":"string","description":"Collection ID"},"name":"collection_id","in":"path"},{"description":"Item ID","required":true,"schema":{"title":"Item Id","type":"string","description":"Item ID"},"name":"item_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Transaction Extension"],"summary":"Update Item","description":"Endpoint.","operationId":"Update_Item_collections__collection_id__items__item_id__put","parameters":[{"description":"Collection ID","required":true,"schema":{"title":"Collection Id","type":"string","description":"Collection ID"},"name":"collection_id","in":"path"},{"description":"Item ID","required":true,"schema":{"title":"Item Id","type":"string","description":"Item ID"},"name":"item_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Transaction Extension"],"summary":"Delete Item","description":"Endpoint.","operationId":"Delete_Item_collections__collection_id__items__item_id__delete","parameters":[{"description":"Collection ID","required":true,"schema":{"title":"Collection Id","type":"string","description":"Collection ID"},"name":"collection_id","in":"path"},{"description":"Item ID","required":true,"schema":{"title":"Item Id","type":"string","description":"Item ID"},"name":"item_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/search":{"get":{"summary":"Search","description":"Endpoint.","operationId":"Search_search_get","parameters":[{"required":false,"schema":{"title":"Collections","type":"string"},"name":"collections","in":"query"},{"required":false,"schema":{"title":"Ids","type":"string"},"name":"ids","in":"query"},{"required":false,"schema":{"title":"Bbox","type":"string"},"name":"bbox","in":"query"},{"required":false,"schema":{"title":"Intersects","type":"string"},"name":"intersects","in":"query"},{"required":false,"schema":{"title":"Datetime","type":"string"},"name":"datetime","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":10},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Query","type":"string"},"name":"query","in":"query"},{"required":false,"schema":{"title":"Sortby","type":"string"},"name":"sortby","in":"query"},{"required":false,"schema":{"title":"Fields","type":"string"},"name":"fields","in":"query"},{"required":false,"schema":{"title":"Token","type":"string"},"name":"token","in":"query"},{"required":false,"schema":{"title":"Filter","type":"string"},"name":"filter","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/geo+json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Search","description":"Endpoint.","operationId":"Search_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPostRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/geo+json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/collections":{"get":{"summary":"Get Collections","description":"Endpoint.","operationId":"Get_Collections_collections_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"put":{"tags":["Transaction Extension"],"summary":"Update Collection","description":"Endpoint.","operationId":"Update_Collection_collections_put","requestBody":{"content":{"application/json":{"schema":{"title":"Request Data","type":"object"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Transaction Extension"],"summary":"Create Collection","description":"Endpoint.","operationId":"Create_Collection_collections_post","requestBody":{"content":{"application/json":{"schema":{"title":"Request Data","type":"object"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/collections/{collection_id}":{"get":{"summary":"Get Collection","description":"Endpoint.","operationId":"Get_Collection_collections__collection_id__get","parameters":[{"description":"Collection ID","required":true,"schema":{"title":"Collection Id","type":"string","description":"Collection ID"},"name":"collection_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Transaction Extension"],"summary":"Delete Collection","description":"Endpoint.","operationId":"Delete_Collection_collections__collection_id__delete","parameters":[{"description":"Collection ID","required":true,"schema":{"title":"Collection Id","type":"string","description":"Collection ID"},"name":"collection_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/collections/{collection_id}/items":{"get":{"summary":"Get Itemcollection","description":"Endpoint.","operationId":"Get_ItemCollection_collections__collection_id__items_get","parameters":[{"description":"Collection ID","required":true,"schema":{"title":"Collection Id","type":"string","description":"Collection ID"},"name":"collection_id","in":"path"},{"required":false,"schema":{"title":"Limit","type":"integer","default":10},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Bbox","type":"string"},"name":"bbox","in":"query"},{"required":false,"schema":{"title":"Datetime","type":"string"},"name":"datetime","in":"query"},{"required":false,"schema":{"title":"Token","type":"string"},"name":"token","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/geo+json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Transaction Extension"],"summary":"Create Item","description":"Endpoint.","operationId":"Create_Item_collections__collection_id__items_post","parameters":[{"description":"Collection ID","required":true,"schema":{"title":"Collection Id","type":"string","description":"Collection ID"},"name":"collection_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/queryables":{"get":{"tags":["Filter Extension"],"summary":"Queryables","description":"Endpoint.","operationId":"Queryables_queryables_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/collections/{collection_id}/queryables":{"get":{"tags":["Filter Extension"],"summary":"Collection Queryables","description":"Endpoint.","operationId":"Collection_Queryables_collections__collection_id__queryables_get","parameters":[{"description":"Collection ID","required":true,"schema":{"title":"Collection Id","type":"string","description":"Collection ID"},"name":"collection_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/collections/{collection_id}/bulk_items":{"post":{"tags":["Bulk Transaction Extension"],"summary":"Bulk Create Item","description":"Endpoint.","operationId":"Bulk_Create_Item_collections__collection_id__bulk_items_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Bulk Create Item Collections Collection Id Bulk Items Post","type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/_mgmt/ping":{"get":{"tags":["Liveliness/Readiness"],"summary":"Ping","description":"Liveliness/readiness probe.","operationId":"ping__mgmt_ping_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"FilterLang":{"title":"FilterLang","enum":["cql-json","cql2-json","cql2-text"],"type":"string","description":"Choices for filter-lang value in a POST request.\n\nBased on https://github.com/radiantearth/stac-api-spec/tree/master/fragments/filter#queryables\n\nNote the addition of cql2-json, which is used by the pgstac backend,\nbut is not included in the spec above."},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"Item":{"title":"Item","type":"object","properties":{"type":{"title":"Type","type":"string"},"stac_version":{"title":"Stac Version","type":"string"},"stac_extensions":{"title":"Stac Extensions","type":"array","items":{"type":"string"}},"id":{"title":"Id","type":"string"},"geometry":{"title":"Geometry","type":"object"},"bbox":{"title":"Bbox","type":"array","items":{"anyOf":[{"type":"number"},{"type":"integer"}]}},"properties":{"title":"Properties","type":"object"},"links":{"title":"Links","type":"array","items":{"type":"object"}},"assets":{"title":"Assets","type":"object"},"collection":{"title":"Collection","type":"string"}}},"Items":{"title":"Items","type":"object","properties":{"items":{"title":"Items","type":"object","extra":{}}},"description":"A group of STAC Item objects, in the form of a dictionary from Item.id -> Item."},"LineString":{"title":"LineString","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"LineString","const":"LineString"},"coordinates":{"title":"Coordinates","minItems":2,"type":"array","items":{"anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":[{"type":"number"},{"type":"number"}]},{"maxItems":3,"minItems":3,"type":"array","items":[{"type":"number"},{"type":"number"},{"type":"number"}]}]}}},"description":"LineString Model"},"MultiLineString":{"title":"MultiLineString","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"MultiLineString","const":"MultiLineString"},"coordinates":{"title":"Coordinates","minItems":1,"type":"array","items":{"minItems":2,"type":"array","items":{"anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":[{"type":"number"},{"type":"number"}]},{"maxItems":3,"minItems":3,"type":"array","items":[{"type":"number"},{"type":"number"},{"type":"number"}]}]}}}},"description":"MultiLineString Model"},"MultiPoint":{"title":"MultiPoint","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"MultiPoint","const":"MultiPoint"},"coordinates":{"title":"Coordinates","minItems":1,"type":"array","items":{"anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":[{"type":"number"},{"type":"number"}]},{"maxItems":3,"minItems":3,"type":"array","items":[{"type":"number"},{"type":"number"},{"type":"number"}]}]}}},"description":"MultiPoint Model"},"MultiPolygon":{"title":"MultiPolygon","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"MultiPolygon","const":"MultiPolygon"},"coordinates":{"title":"Coordinates","minItems":1,"type":"array","items":{"minItems":1,"type":"array","items":{"minItems":4,"type":"array","items":{"anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":[{"type":"number"},{"type":"number"}]},{"maxItems":3,"minItems":3,"type":"array","items":[{"type":"number"},{"type":"number"},{"type":"number"}]}]}}}}},"description":"MultiPolygon Model"},"Point":{"title":"Point","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"Point","const":"Point"},"coordinates":{"title":"Coordinates","anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":[{"type":"number"},{"type":"number"}]},{"maxItems":3,"minItems":3,"type":"array","items":[{"type":"number"},{"type":"number"},{"type":"number"}]}]}},"description":"Point Model"},"Polygon":{"title":"Polygon","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"Polygon","const":"Polygon"},"coordinates":{"title":"Coordinates","minItems":1,"type":"array","items":{"minItems":4,"type":"array","items":{"anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":[{"type":"number"},{"type":"number"}]},{"maxItems":3,"minItems":3,"type":"array","items":[{"type":"number"},{"type":"number"},{"type":"number"}]}]}}}},"description":"Polygon Model"},"PostFieldsExtension":{"title":"PostFieldsExtension","type":"object","properties":{"include":{"title":"Include","uniqueItems":true,"type":"array","items":{"type":"string"},"default":[]},"exclude":{"title":"Exclude","uniqueItems":true,"type":"array","items":{"type":"string"},"default":[]}},"description":"FieldsExtension.\n\nAttributes:\n include: set of fields to include.\n exclude: set of fields to exclude."},"SearchPostRequest":{"title":"SearchPostRequest","type":"object","properties":{"collections":{"title":"Collections","type":"array","items":{"type":"string"},"extra":{}},"ids":{"title":"Ids","type":"array","items":{"type":"string"},"extra":{}},"bbox":{"title":"Bbox","anyOf":[{"maxItems":4,"minItems":4,"type":"array","items":[{"anyOf":[{"type":"number"},{"type":"integer"}]},{"anyOf":[{"type":"number"},{"type":"integer"}]},{"anyOf":[{"type":"number"},{"type":"integer"}]},{"anyOf":[{"type":"number"},{"type":"integer"}]}]},{"maxItems":6,"minItems":6,"type":"array","items":[{"anyOf":[{"type":"number"},{"type":"integer"}]},{"anyOf":[{"type":"number"},{"type":"integer"}]},{"anyOf":[{"type":"number"},{"type":"integer"}]},{"anyOf":[{"type":"number"},{"type":"integer"}]},{"anyOf":[{"type":"number"},{"type":"integer"}]},{"anyOf":[{"type":"number"},{"type":"integer"}]}]}],"extra":{}},"intersects":{"title":"Intersects","anyOf":[{"$ref":"#/components/schemas/Point"},{"$ref":"#/components/schemas/MultiPoint"},{"$ref":"#/components/schemas/LineString"},{"$ref":"#/components/schemas/MultiLineString"},{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"extra":{}},"datetime":{"title":"Datetime","type":"string","extra":{}},"limit":{"title":"Limit","maximum":10000.0,"exclusiveMinimum":0.0,"type":"integer","default":10,"extra":{}},"conf":{"title":"Conf","type":"object","extra":{}},"query":{"title":"Query","type":"object","additionalProperties":{"type":"object"},"extra":{}},"sortby":{"title":"Sortby","type":"array","items":{"$ref":"#/components/schemas/SortExtension"},"extra":{}},"fields":{"title":"Fields","allOf":[{"$ref":"#/components/schemas/PostFieldsExtension"}],"default":{"include":[],"exclude":[]},"extra":{}},"token":{"title":"Token","type":"string","extra":{}},"filter":{"title":"Filter","type":"object","extra":{}},"filter-crs":{"title":"Filter-Crs","type":"string","extra":{}},"filter-lang":{"allOf":[{"$ref":"#/components/schemas/FilterLang"}],"default":"cql-json","extra":{}}},"description":"Search model.\n\nOverrides the validation for datetime from the base request model."},"SortDirections":{"title":"SortDirections","enum":["asc","desc"],"type":"string","description":"An enumeration."},"SortExtension":{"title":"SortExtension","required":["field","direction"],"type":"object","properties":{"field":{"title":"Field","minLength":1,"type":"string"},"direction":{"$ref":"#/components/schemas/SortDirections"}},"description":"https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort#sort-api-extension"},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}}}} |