Skip to content

Commit 9d3c850

Browse files
m-mohrm-mohr
committed
Removed OpenAPI endpoints until further details has been decided on, see #68.
1 parent 4ed619c commit 9d3c850

File tree

1 file changed

+1
-193
lines changed

1 file changed

+1
-193
lines changed

‎openapi.json

+1-193
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"info": {
1515
"title": "OpenEO API",
1616
"version": "0.3.0",
17-
"description": "The OpenEO API specification for interoperable cloud-based processing of large Earth observation datasets. **This early draft version is incomplete and intended for working on a prototype and a proof of concept.** Things that are currently missing particularly include: \n * Authentication and authorization with OAuth 2.0, \n * how results of computations can be downloaded, \n * how data is streamed into UDFs and how the output of UDFs is returned, \n * how services are organized as microservices, \n * how payments can be handled,\n * how resources (e.g. process graphs) can be shared,\n * and how OpenSearch is interfaced",
17+
"description": "The OpenEO API specification for interoperable cloud-based processing of large Earth observation datasets. **This early draft version is incomplete and intended for working on a prototype and a proof of concept.** Things that are currently missing particularly include: \n * Authentication and authorization with OAuth 2.0, \n * how results of computations can be downloaded, \n * how data is streamed into UDFs and how the output of UDFs is returned, \n * how services are organized as microservices, \n * how payments can be handled,\n * how resources (e.g. process graphs) can be shared.",
1818
"contact": {
1919
"name": "openEO Consortium",
2020
"url": "http://www.openeo.org",
@@ -331,102 +331,6 @@
331331
}
332332
}
333333
},
334-
"/data/opensearch": {
335-
"options": {
336-
"summary": "Response to allow Cross-Origin Resource Sharing.",
337-
"description": "Response for the preflight requests made by some clients due to Cross-Origin Resource Sharing restrictions. It sends the appropriate headers for this endpoint as defined in the section \"Responses\". See https://www.w3.org/TR/cors/ for more information.",
338-
"tags": [
339-
"CORS"
340-
],
341-
"responses": {
342-
"204": {
343-
"$ref": "#/components/responses/cors_options"
344-
},
345-
"405": {
346-
"$ref": "#/components/responses/method_not_allowed"
347-
},
348-
"500": {
349-
"$ref": "#/components/responses/server_error"
350-
}
351-
}
352-
},
353-
"get": {
354-
"summary": "OpenSearch endpoint to receive standardized data search results.",
355-
"description": "This service offers more complex search functionality and returns results in an OpenSearch compliant Atom XML format.",
356-
"tags": [
357-
"EO Data Discovery"
358-
],
359-
"security": [
360-
{},
361-
{
362-
"Bearer": []
363-
}
364-
],
365-
"parameters": [
366-
{
367-
"in": "query",
368-
"name": "q",
369-
"description": "string expression to search available datasets",
370-
"required": false,
371-
"schema": {
372-
"type": "string"
373-
}
374-
},
375-
{
376-
"in": "query",
377-
"name": "start",
378-
"description": "page start value",
379-
"required": false,
380-
"schema": {
381-
"type": "integer"
382-
}
383-
},
384-
{
385-
"in": "query",
386-
"name": "rows",
387-
"description": "page size value",
388-
"required": false,
389-
"schema": {
390-
"type": "integer"
391-
}
392-
}
393-
],
394-
"responses": {
395-
"200": {
396-
"description": "An array of EO datasets including their unique identifiers and some basic metadata.",
397-
"headers": {
398-
"Access-Control-Allow-Origin": {
399-
"$ref": "#/components/headers/allow_origin"
400-
},
401-
"Access-Control-Allow-Credentials": {
402-
"$ref": "#/components/headers/allow_credentials"
403-
}
404-
},
405-
"content": {
406-
"application/atom+xml": {
407-
"examples": {
408-
"response": {
409-
"value": "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <feed xmlns=\"http://www.w3.org/2005/Atom\" \n xmlns:opensearch=\"http://a9.com/-/spec/opensearch/1.1/\">\n <title>Supported EO datasets by Example, Inc.</title>\n <updated>2018-01-18T10:30:00Z</updated>\n <author>\n <name>Example, Inc.</name>\n </author> \n <id>urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6</id>\n <link rel=\"self\" href=\"http://www.exmaple.com/api/1.0/data/opensearch\"/>\n <link rel=\"search\" type=\"application/opensearchdescription+xml\" href=\"http://example.com/api/1.0/data/opensearch/description.xml\"/>\n <opensearch:totalResults>3</opensearch:totalResults>\n <opensearch:Query role=\"request\" startPage=\"1\" />\n <entry>\n <title>MOD09Q1</title>\n <link rel=\"alternate\" href=\"http://www.exmaple.com/api/1.0/data/MOD09Q1\"/>\n <id>urn:uuid:1223c695-cfb8-4ebb-aaaa-80da344efa6a</id>\n <updated>2017-09-18T10:30:00Z</updated>\n <rights type=\"text\">U.S. Geological Survey (USGS), DOI: 10.5067/MODIS/MOD09Q1.006</rights>\n <summary type=\"text\">MODIS/Terra Surface Reflectance 8-Day L3 Global 250m SIN Grid V00 </summary>\n </entry>\n <entry>\n <title>SENTINEL2-1C</title>\n <link rel=\"alternate\" href=\"http://www.exmaple.com/api/1.0/data/SENTINEL2-1C\"/>\n <id>urn:uuid:1224c695-cfc8-4ebb-bbbb-90da344efa6b</id>\n <updated>2017-12-01T01:00:00Z</updated>\n <rights type=\"text\">European Space Agency (ESA)</rights>\n <summary type=\"text\">Sentinel 2 Level-1C: Top-of-atmosphere reflectances in cartographic geometry</summary>\n </entry>\n <entry>\n <title>LandsatETM+</title>\n <link rel=\"alternate\" href=\"http://www.exmaple.com/api/1.0/data/LandsatETM%2B\"/>\n <id>urn:uuid:1225c695-cfd8-4ebb-cccc-70da344efa6c</id>\n <updated>2015-01-10T22:45:12Z</updated>\n <rights type=\"text\">U.S. Geological Survey (USGS)</rights>\n <summary type=\"text\">Landsat Enhanced Thematic Mapper Plus (ETM+)</summary>\n </entry>\n</feed>"
410-
}
411-
}
412-
}
413-
}
414-
},
415-
"400": {
416-
"$ref": "#/components/responses/client_error"
417-
},
418-
"401": {
419-
"$ref": "#/components/responses/unauthorized"
420-
},
421-
"403": {
422-
"$ref": "#/components/responses/forbidden"
423-
},
424-
"500": {
425-
"$ref": "#/components/responses/server_error"
426-
}
427-
}
428-
}
429-
},
430334
"/data/{product_id}": {
431335
"parameters": [
432336
{
@@ -813,102 +717,6 @@
813717
}
814718
}
815719
},
816-
"/processes/opensearch": {
817-
"options": {
818-
"summary": "Response to allow Cross-Origin Resource Sharing.",
819-
"description": "Response for the preflight requests made by some clients due to Cross-Origin Resource Sharing restrictions. It sends the appropriate headers for this endpoint as defined in the section \"Responses\". See https://www.w3.org/TR/cors/ for more information.",
820-
"tags": [
821-
"CORS"
822-
],
823-
"responses": {
824-
"204": {
825-
"$ref": "#/components/responses/cors_options"
826-
},
827-
"405": {
828-
"$ref": "#/components/responses/method_not_allowed"
829-
},
830-
"500": {
831-
"$ref": "#/components/responses/server_error"
832-
}
833-
}
834-
},
835-
"get": {
836-
"summary": "OpenSearch endpoint to request standardized process search results.",
837-
"description": "This service offers more complex search functionality and returns results in an OpenSearch compliant Atom XML format.",
838-
"tags": [
839-
"Process Discovery"
840-
],
841-
"security": [
842-
{},
843-
{
844-
"Bearer": []
845-
}
846-
],
847-
"parameters": [
848-
{
849-
"name": "q",
850-
"in": "query",
851-
"description": "string expression to search available processes",
852-
"required": false,
853-
"schema": {
854-
"type": "string"
855-
}
856-
},
857-
{
858-
"name": "start",
859-
"in": "query",
860-
"description": "page start value",
861-
"required": false,
862-
"schema": {
863-
"type": "integer"
864-
}
865-
},
866-
{
867-
"name": "rows",
868-
"in": "query",
869-
"description": "page size value",
870-
"required": false,
871-
"schema": {
872-
"type": "integer"
873-
}
874-
}
875-
],
876-
"responses": {
877-
"200": {
878-
"description": "OpenSearch response",
879-
"headers": {
880-
"Access-Control-Allow-Origin": {
881-
"$ref": "#/components/headers/allow_origin"
882-
},
883-
"Access-Control-Allow-Credentials": {
884-
"$ref": "#/components/headers/allow_credentials"
885-
}
886-
},
887-
"content": {
888-
"application/atom+xml": {
889-
"examples": {
890-
"response": {
891-
"value": "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <feed xmlns=\"http://www.w3.org/2005/Atom\" \n xmlns:opensearch=\"http://a9.com/-/spec/opensearch/1.1/\">\n <title>Supported EO processes by Example, Inc.</title>\n <updated>2018-01-18T10:30:00Z</updated>\n <author>\n <name>Example, Inc.</name>\n </author> \n <id>urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6</id>\n <link rel=\"self\" href=\"http://www.exmaple.com/api/1.0/processes/opensearch\"/>\n <link rel=\"search\" type=\"application/opensearchdescription+xml\" href=\"http://example.com/api/1.0/processes/opensearch/description.xml\"/>\n <opensearch:totalResults>2</opensearch:totalResults>\n <opensearch:Query role=\"request\" startPage=\"1\" />\n <entry>\n <title>NDVI</title>\n <link rel=\"alternate\" href=\"http://www.exmaple.com/api/1.0/processes/NDVI\"/>\n <id>urn:uuid:1223c695-cfb8-4ebb-aaaa-80da344efa6a</id>\n <updated>2018-01-18T10:30:00Z</updated>\n <summary type=\"text\">Computes the normalized difference vegetation index (NDVI) for all pixels of the input dataset.</summary>\n </entry>\n <entry>\n <title>median_time</title>\n <link rel=\"alternate\" href=\"http://www.exmaple.com/api/1.0/data/median_time\"/>\n <id>urn:uuid:1224c695-cfc8-4ebb-bbbb-90da344efa6b</id>\n <updated>2018-01-18T10:30:00Z</updated>\n <summary type=\"text\">Applies median aggregation to pixel time series for all bands of the input dataset.</summary>\n </entry>\n</feed>"
892-
}
893-
}
894-
}
895-
}
896-
},
897-
"400": {
898-
"$ref": "#/components/responses/client_error"
899-
},
900-
"401": {
901-
"$ref": "#/components/responses/unauthorized"
902-
},
903-
"403": {
904-
"$ref": "#/components/responses/forbidden"
905-
},
906-
"500": {
907-
"$ref": "#/components/responses/server_error"
908-
}
909-
}
910-
}
911-
},
912720
"/processes/{process_id}": {
913721
"parameters": [
914722
{

0 commit comments

Comments
 (0)