[949] | 1 | [openapi] |
---|
| 2 | rootUrl=https://demo.mapmint.com/wps3/ |
---|
| 3 | links=/,/api,,/conformance,/processes |
---|
| 4 | paths=/root,/api,/conformance,/processes,/processes/{id},/processes/{id}/jobs,/processes/{id}/jobs/{jobID},/processes/{id}/jobs/{jobID}/result |
---|
| 5 | paths2=,/processes/{id}/jobs/{jobID}/result/{resultID} |
---|
| 6 | paths1=p,processes/{id}/jobs,,processes/{id}/jobs/{jobID} |
---|
| 7 | parameters=id,jobID,resultID |
---|
| 8 | header_parameters=oas-header1,oas-header2 |
---|
| 9 | version=3.0.1 |
---|
| 10 | |
---|
| 11 | [oas-header1] |
---|
| 12 | in=header |
---|
| 13 | name=Prefer |
---|
| 14 | type=string |
---|
| 15 | required=false |
---|
| 16 | enum=respond-async |
---|
| 17 | |
---|
| 18 | [oas-header2] |
---|
| 19 | in=header |
---|
| 20 | name=Prefer |
---|
| 21 | type=string |
---|
| 22 | required=false |
---|
| 23 | enum=return=representation,return=minimal |
---|
| 24 | |
---|
| 25 | [/] |
---|
| 26 | rel=self |
---|
| 27 | type=application/json |
---|
| 28 | title=this document |
---|
| 29 | |
---|
| 30 | [root] |
---|
| 31 | method=get |
---|
| 32 | title=landing page of this API |
---|
| 33 | abstract=The landing page provides links to the API definition, the Conformance statements and the metadata about the processes offered by this service. |
---|
| 34 | tags=Home |
---|
| 35 | tags_description= |
---|
| 36 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/root.yaml |
---|
| 37 | |
---|
| 38 | [/api] |
---|
| 39 | rel=service |
---|
| 40 | type=application/openapi+json;version=3.0 |
---|
| 41 | title=the API definition |
---|
| 42 | |
---|
| 43 | [api] |
---|
| 44 | method=get |
---|
| 45 | title=This document |
---|
| 46 | abstract=This document |
---|
| 47 | tags=API |
---|
| 48 | tags_description= |
---|
| 49 | schema= |
---|
| 50 | |
---|
| 51 | [/conformance] |
---|
| 52 | rel=conformance |
---|
| 53 | type=application/json |
---|
| 54 | title=WPS 2.0 REST/JSON Binding Extension conformance classes implemented by this server |
---|
| 55 | |
---|
| 56 | [conformance] |
---|
| 57 | method=get |
---|
| 58 | title=information about standards that this API conforms to |
---|
| 59 | abstract==list all requirements classes specified in a standard (e.g., WPS REST/JSON Binding Core) that the server conforms to |
---|
| 60 | tags=Conformance |
---|
| 61 | tags_description= |
---|
| 62 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/req-classes.yaml |
---|
| 63 | |
---|
| 64 | [/processes] |
---|
| 65 | rel=processes |
---|
| 66 | type=application/json |
---|
| 67 | title=The processes offered by this server |
---|
| 68 | |
---|
| 69 | [processes] |
---|
| 70 | method=get |
---|
| 71 | title=retrieve available processes |
---|
| 72 | abstract=Information about the available processes |
---|
| 73 | tags=GetCapabilities |
---|
| 74 | tags_description= |
---|
| 75 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/processCollection.yaml |
---|
| 76 | |
---|
| 77 | [processes/{id}] |
---|
| 78 | method=get |
---|
| 79 | title=retrieve a process description |
---|
| 80 | abstract=A process description. |
---|
| 81 | tags=ProcessDescription |
---|
| 82 | tags_description= |
---|
| 83 | schemat=https://demo.mapmint.com/wps-rest-binding/core/openapi/schemas/process.yaml |
---|
| 84 | schematr=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/processOffering.yaml |
---|
| 85 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/process.yaml |
---|
| 86 | parameters=/components/parameters/id |
---|
| 87 | |
---|
| 88 | |
---|
| 89 | [/processes/{id}/jobs] |
---|
| 90 | rel=canonical |
---|
| 91 | type=application/json |
---|
| 92 | title=Process Description |
---|
| 93 | |
---|
| 94 | [processes/{id}/jobs] |
---|
| 95 | length=2 |
---|
| 96 | method=get |
---|
| 97 | title=retrieve a list of jobs run |
---|
| 98 | abstract=A list of jobs run. |
---|
| 99 | tags=JobList |
---|
| 100 | tags_description= |
---|
| 101 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/jobCollection.yaml |
---|
| 102 | parameters=/components/parameters/id |
---|
| 103 | method_1=post |
---|
| 104 | title_1=execute a job |
---|
| 105 | abstract_1=An execute endpoint. |
---|
| 106 | tags_1=Execute Endpoint |
---|
| 107 | tags_description_1= |
---|
| 108 | schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/result.yaml |
---|
| 109 | parameters_1=/components/parameters/id,/components/parameters/oas-header1 |
---|
| 110 | |
---|
| 111 | [requestBody] |
---|
| 112 | abstract=Mandatory execute request in JSON format |
---|
| 113 | type=application/json |
---|
| 114 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/execute.yaml |
---|
| 115 | |
---|
| 116 | [/processes/{id}/jobs/{jobID}] |
---|
| 117 | rel=canonical |
---|
| 118 | type=application/json |
---|
| 119 | title=Status |
---|
| 120 | |
---|
| 121 | [processes/{id}/jobs/{jobID}] |
---|
| 122 | method=get |
---|
| 123 | title=The status of a job. |
---|
| 124 | abstract=The status of a job. |
---|
| 125 | tags=GetStatus |
---|
| 126 | tags_description= |
---|
| 127 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/statusInfo.yaml |
---|
| 128 | parameters=/components/parameters/id,/components/parameters/jobID |
---|
| 129 | |
---|
| 130 | [/processes/{id}/jobs/{jobID}/result] |
---|
| 131 | rel=canonical |
---|
| 132 | type=application/json |
---|
| 133 | title=Get Result |
---|
| 134 | |
---|
| 135 | [processes/{id}/jobs/{jobID}/result] |
---|
| 136 | method=get |
---|
| 137 | title=The result of a job execution. |
---|
| 138 | abstract=The result of a job execution. |
---|
| 139 | tags=GetResult |
---|
| 140 | tags_description= |
---|
| 141 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/result.yaml |
---|
| 142 | parameters=/components/parameters/id,/components/parameters/jobID |
---|
| 143 | ep=,/components/parameters/oas-header2 |
---|
| 144 | |
---|
| 145 | [/processes/{id}/jobs/{jobID}/result/{resultID}] |
---|
| 146 | rel=canonical |
---|
| 147 | type=application/json |
---|
| 148 | title=Get Result |
---|
| 149 | |
---|
| 150 | [processes/{id}/jobs/{jobID}/result/{resultID}] |
---|
| 151 | method=get |
---|
| 152 | title=The result of a job execution. |
---|
| 153 | abstract=The result of a job execution. |
---|
| 154 | tags=GetResult |
---|
| 155 | tags_description= |
---|
| 156 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/valueType.yaml |
---|
| 157 | parameters=/components/parameters/id,/components/parameters/jobID,/components/parameters/resultID,/components/parameters/oas-header2 |
---|
| 158 | |
---|
| 159 | |
---|
| 160 | [{id}] |
---|
| 161 | type=string |
---|
| 162 | title=The id of a process |
---|
| 163 | abstract=The id of a process |
---|
| 164 | in=path |
---|
| 165 | required=true |
---|
| 166 | example=buffer |
---|
| 167 | |
---|
| 168 | [{jobID}] |
---|
| 169 | type=string |
---|
| 170 | title=The id of a job |
---|
| 171 | abstract=The id of a job |
---|
| 172 | in=path |
---|
| 173 | required=true |
---|
| 174 | |
---|
| 175 | [{resultID}] |
---|
| 176 | type=string |
---|
| 177 | title=The id of an output |
---|
| 178 | abstract=The id of an output |
---|
| 179 | in=path |
---|
| 180 | required=true |
---|
| 181 | |
---|
| 182 | [{f}] |
---|
| 183 | default=json |
---|
| 184 | enum=json |
---|
| 185 | title=The optional f parameter |
---|
| 186 | abstract=The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is JSON. |
---|
| 187 | in=query |
---|
| 188 | required=false |
---|
| 189 | |
---|
| 190 | [conformTo] |
---|
| 191 | rootUrl=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/ |
---|
| 192 | link=core |
---|
| 193 | link_1=oas30 |
---|
| 194 | link_2=json |
---|
| 195 | length=3 |
---|
| 196 | |
---|
| 197 | [exception] |
---|
| 198 | abstract=Exception |
---|
| 199 | type=application/json |
---|
| 200 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/exception.yaml |
---|