Skip to content

Commit

Permalink
Removed UDFs until we have #87 solved.
Browse files Browse the repository at this point in the history
  • Loading branch information
@m-mohr
m-mohr committed Jun 4, 2018
1 parent 6aea4cf commit 6fc2d0f
Showing 1 changed file with 0 additions and 255 deletions.
255 changes: 0 additions & 255 deletions openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,6 @@
"name": "Process Discovery",
"description": "Discovery of processes that are available at the back-end."
},
{
"name": "UDF Runtime Discovery",
"description": "Discovery of programming languages and their runtime environments to execute user-defined functions at the back-end."
},
{
"name": "User Content",
"description": "Services working with user content."
Expand Down Expand Up @@ -2388,184 +2384,6 @@
}
}
}
},
"/udf_runtimes": {
"get": {
"summary": "Returns the programming languages including their environments and UDF types supported.",
"description": "Describes how custom user-defined functions can be exposed to the data and which programming languages and environments are supported by the back-end.",
"tags": [
"UDF Runtime Discovery"
],
"security": [
{},
{
"Bearer": []
}
],
"responses": {
"200": {
"description": "Description of UDF runtime support",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "A map with language identifiers such as `R` as keys and an object that defines available versions, extension packages, and UDF schemas.",
"additionalProperties": {
"type": "object",
"properties": {
"udf_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/udf_type"
}
},
"versions": {
"type": "object",
"description": "A map with version identifiers as keys and an object value that specifies which extension packages are available for the particular version.",
"additionalProperties": {
"description": "Extension package identifiers that should include their version number such as `'sf__0.5-4'`",
"properties": {
"packages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"R": {
"udf_types": [
"reduce_time",
"reduce_space",
"apply_pixel"
],
"versions": {
"3.1.0": {
"packages": [
"Rcpp_0.12.10",
"sp_1.2-5",
"rmarkdown_1.6"
]
},
"3.3.3": {
"packages": [
"Rcpp_0.12.10",
"sf_0.5-4",
"spacetime_1.2-0"
]
}
}
}
}
}
}
}
}
},
"4XX": {
"$ref": "#/components/responses/client_error_auth"
},
"5XX": {
"$ref": "#/components/responses/server_error"
}
}
}
},
"/udf_runtimes/{lang}/{udf_type}": {
"parameters": [
{
"name": "lang",
"in": "path",
"description": "Language identifier such as `R`",
"required": true,
"schema": {
"type": "string",
"enum": [
"python",
"R"
]
}
},
{
"name": "udf_type",
"in": "path",
"description": "The UDF types define how UDFs can be exposed to the data, how they can be parallelized, and how the result schema should be structured.",
"required": true,
"schema": {
"type": "string",
"enum": [
"apply_pixel",
"apply_scene",
"reduce_time",
"reduce_space",
"window_time",
"window_space",
"window_spacetime",
"aggregate_time",
"aggregate_space",
"aggregate_spacetime"
]
}
}
],
"get": {
"summary": "Returns the process description of UDF schemas.",
"description": "Returns the process description of UDF schemas, which offer different possibilities how user-defined scripts can be applied to the data.",
"tags": [
"UDF Runtime Discovery"
],
"security": [
{},
{
"Bearer": []
}
],
"responses": {
"200": {
"description": "Process description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/udf_description"
},
"examples": {
"response": {
"value": {
"process_id": "/udf/R/reduce_time",
"description": "Applies the given R script on all time series of the input imagery. The R script gets pixel values (all bands) of complete time series as input and must result in a single value or tuple for multiple bands.",
"args": {
"imagery": {
"description": "input image time series"
},
"script": {
"description": "R script that will be applied over time series"
}
}
}
}
}
}
}
},
"4XX": {
"$ref": "#/components/responses/client_error_auth"
},
"5XX": {
"$ref": "#/components/responses/server_error"
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -2643,79 +2461,6 @@
},
"additionalProperties": true
},
"udf_type": {
"type": "string",
"description": "The UDF types define how UDFs can be exposed to the data, how they can be parallelized, and how the result schema should be structured.",
"enum": [
"apply_pixel",
"apply_scene",
"reduce_time",
"reduce_space",
"window_time",
"window_space",
"window_spacetime",
"agregate_time",
"aggregate_space",
"aggregate_spacetime"
]
},
"udf_description": {
"description": "Defines and describes a UDF using the same schema as the description of processes offered by the back-end.",
"type": "object",
"required": [
"process_id",
"description"
],
"properties": {
"process_id": {
"type": "string",
"description": "The unique identifier of the process."
},
"description": {
"type": "string",
"description": "A short and concise description of what the process does and how the output looks like."
},
"link": {
"type": "string",
"description": "Reference to an external process definition if the process has been defined over different back ends within OpenEO"
},
"args": {
"type": "object",
"additionalProperties": {
"type": "object",
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "A short and concise description of the process argument."
},
"required": {
"type": "boolean",
"default": true,
"description": "Defines whether an argument is required or optional."
}
},
"additionalProperties": true
}
}
},
"example": {
"process_id": "udf/R/reduce_time",
"description": "Applies an R function independently over all input time series that produces a zero-dimensional value (scalar or multi-band tuple) as output (per time series).",
"args": {
"imagery": {
"description": "input (image) time series",
"required": true
},
"script": {
"description": "Script resource that has been uploaded to user space before. ",
"required": true
}
}
}
},
"process_graph": {
"description": "A process graph defines an executable process, i.e. one process or a combination of chained processes including specific arguments.",
"type": "object",
Expand Down

0 comments on commit 6fc2d0f

Please sign in to comment.