| 1 | [openapi] |
---|
| 2 | use_content=false |
---|
| 3 | rootUrl=https://myserver/ogc-api |
---|
| 4 | links=/,/api,/conformance,/processes |
---|
| 5 | paths=/root,/api,/conformance,/processes,/processes/{id},/processes/{id}/jobs,/processes/{id}/jobs/{jobID},/processes/{id}/jobs/{jobID}/results |
---|
| 6 | parameters=id,jobID,resultID |
---|
| 7 | version=3.0.2 |
---|
| 8 | license_name=OGC license |
---|
| 9 | license_url=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/LICENSE |
---|
| 10 | full_html_support=false |
---|
| 11 | partial_html_support=true |
---|
| 12 | wsUrl=wss://demo.mapmint.com:4430/ |
---|
| 13 | publisherUrl=http://127.0.0.1/cgi-bin3/publish.py?jobid= |
---|
| 14 | |
---|
| 15 | [/] |
---|
| 16 | rel=self |
---|
| 17 | type=application/json |
---|
| 18 | title=this document |
---|
| 19 | |
---|
| 20 | [root] |
---|
| 21 | method=get |
---|
| 22 | title=landing page of this API |
---|
| 23 | abstract=The landing page provides links to the API definition, the Conformance statements and the metadata about the processes offered by this service. |
---|
| 24 | tags=Home |
---|
| 25 | tags_description= |
---|
| 26 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/LandingPage.yaml |
---|
| 27 | |
---|
| 28 | [/index.html] |
---|
| 29 | rel=alternate |
---|
| 30 | type=text/html |
---|
| 31 | |
---|
| 32 | [/api] |
---|
| 33 | rel=service-desc |
---|
| 34 | type=application/openapi+json;version=3.0 |
---|
| 35 | title=the API definition |
---|
| 36 | |
---|
| 37 | [/api.html] |
---|
| 38 | rel=service-doc |
---|
| 39 | type=text/hml |
---|
| 40 | |
---|
| 41 | [api.html] |
---|
| 42 | href=https://demo.mapmint.com/swagger-ui/ogc-api-processes/ |
---|
| 43 | |
---|
| 44 | [api] |
---|
| 45 | method=get |
---|
| 46 | title=This document |
---|
| 47 | abstract=This document |
---|
| 48 | tags=API |
---|
| 49 | tags_description= |
---|
| 50 | schema= |
---|
| 51 | |
---|
| 52 | [/conformance] |
---|
| 53 | rel=conformance |
---|
| 54 | type=application/json |
---|
| 55 | title=WPS 2.0 REST/JSON Binding Extension conformance classes implemented by this server |
---|
| 56 | |
---|
| 57 | [conformance] |
---|
| 58 | method=get |
---|
| 59 | title=information about standards that this API conforms to |
---|
| 60 | abstract=list all requirements classes specified in a standard (e.g., WPS REST/JSON Binding Core) that the server conforms to |
---|
| 61 | tags=Conformance |
---|
| 62 | tags_description= |
---|
| 63 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ConformanceDeclaration.yaml |
---|
| 64 | |
---|
| 65 | [/conformance.html] |
---|
| 66 | rel=alternate |
---|
| 67 | type=text/hml |
---|
| 68 | |
---|
| 69 | [/processes] |
---|
| 70 | rel=processes |
---|
| 71 | type=application/json |
---|
| 72 | title=The processes offered by this server |
---|
| 73 | |
---|
| 74 | [processes] |
---|
| 75 | method=get |
---|
| 76 | title=retrieve available processes |
---|
| 77 | abstract=Information about the available processes |
---|
| 78 | tags=GetCapabilities |
---|
| 79 | tags_description= |
---|
| 80 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ProcessList.yaml |
---|
| 81 | |
---|
| 82 | [/processes.html] |
---|
| 83 | rel=alternate |
---|
| 84 | type=text/hml |
---|
| 85 | |
---|
| 86 | [processes/{id}] |
---|
| 87 | method=get |
---|
| 88 | title=retrieve a process description |
---|
| 89 | abstract=A process description. |
---|
| 90 | tags=ProcessDescription |
---|
| 91 | tags_description= |
---|
| 92 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ProcessDescription.yaml |
---|
| 93 | ecode=404 |
---|
| 94 | parameters=/components/parameters/id |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | [/processes/{id}/jobs] |
---|
| 98 | rel=canonical |
---|
| 99 | type=application/json |
---|
| 100 | title=Process Description |
---|
| 101 | |
---|
| 102 | [processes/{id}/jobs] |
---|
| 103 | length=2 |
---|
| 104 | method=get |
---|
| 105 | title=retrieve a list of jobs run |
---|
| 106 | abstract=A list of jobs run. |
---|
| 107 | tags=JobList |
---|
| 108 | tags_description= |
---|
| 109 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/JobList.yaml |
---|
| 110 | parameters=/components/parameters/id |
---|
| 111 | ecode=404,500 |
---|
| 112 | method_1=post |
---|
| 113 | title_1=execute a job |
---|
| 114 | abstract_1=An execute endpoint. |
---|
| 115 | tags_1=Execute Endpoint |
---|
| 116 | tags_description_1= |
---|
| 117 | schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ExecuteSync.yaml |
---|
| 118 | parameters_1=/components/parameters/id |
---|
| 119 | ecode_1=400,404,500 |
---|
| 120 | eschema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ExecuteAsync.yaml |
---|
| 121 | ep=,/components/parameters/oas-header1 |
---|
| 122 | |
---|
| 123 | [requestBody] |
---|
| 124 | abstract=Mandatory execute request in JSON format |
---|
| 125 | type=application/json |
---|
| 126 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/execute.yaml |
---|
| 127 | |
---|
| 128 | [/processes/{id}/jobs/{jobID}] |
---|
| 129 | rel=canonical |
---|
| 130 | type=application/json |
---|
| 131 | title=Status |
---|
| 132 | |
---|
| 133 | [processes/{id}/jobs/{jobID}] |
---|
| 134 | length=2 |
---|
| 135 | method=get |
---|
| 136 | title=The status of a job. |
---|
| 137 | abstract=The status of a job. |
---|
| 138 | tags=GetStatus |
---|
| 139 | tags_description= |
---|
| 140 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/Status.yaml |
---|
| 141 | parameters=/components/parameters/id,/components/parameters/jobID |
---|
| 142 | method_1=delete |
---|
| 143 | title_1=Cancel a job |
---|
| 144 | abstract_1=Cancel the job execution. |
---|
| 145 | tags_1=Dismiss |
---|
| 146 | tags_description_1=Cencel a job execution |
---|
| 147 | schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/Status.yaml |
---|
| 148 | parameters_1=/components/parameters/id,/components/parameters/jobID |
---|
| 149 | ecode_1=404,500 |
---|
| 150 | |
---|
| 151 | |
---|
| 152 | [/processes/{id}/jobs/{jobID}/results] |
---|
| 153 | rel=canonical |
---|
| 154 | type=application/json |
---|
| 155 | title=Get Result |
---|
| 156 | |
---|
| 157 | [processes/{id}/jobs/{jobID}/results] |
---|
| 158 | method=get |
---|
| 159 | title=The result of a job execution. |
---|
| 160 | abstract=The result of a job execution. |
---|
| 161 | tags=GetResult |
---|
| 162 | tags_description= |
---|
| 163 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/Results.yaml |
---|
| 164 | parameters=/components/parameters/id,/components/parameters/jobID |
---|
| 165 | ecode=404,500 |
---|
| 166 | ep=,/components/parameters/oas-header2 |
---|
| 167 | |
---|
| 168 | [/processes/{id}/jobs/{jobID}/result/{resultID}] |
---|
| 169 | rel=canonical |
---|
| 170 | type=application/json |
---|
| 171 | title=Get Result |
---|
| 172 | |
---|
| 173 | [processes/{id}/jobs/{jobID}/result/{resultID}] |
---|
| 174 | method=get |
---|
| 175 | title=The result of a job execution. |
---|
| 176 | abstract=The result of a job execution. |
---|
| 177 | tags=GetResult |
---|
| 178 | tags_description= |
---|
| 179 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/valueType.yaml |
---|
| 180 | parameters=/components/parameters/id,/components/parameters/jobID,/components/parameters/resultID |
---|
| 181 | ep=,/components/parameters/oas-header2 |
---|
| 182 | |
---|
| 183 | |
---|
| 184 | [{id}] |
---|
| 185 | type=string |
---|
| 186 | title=The id of a process |
---|
| 187 | abstract=The id of a process |
---|
| 188 | in=path |
---|
| 189 | required=true |
---|
| 190 | example=buffer |
---|
| 191 | |
---|
| 192 | [{jobID}] |
---|
| 193 | type=string |
---|
| 194 | title=The id of a job |
---|
| 195 | abstract=The id of a job |
---|
| 196 | in=path |
---|
| 197 | required=true |
---|
| 198 | |
---|
| 199 | [{resultID}] |
---|
| 200 | type=string |
---|
| 201 | title=The id of an output |
---|
| 202 | abstract=The id of an output |
---|
| 203 | in=path |
---|
| 204 | required=true |
---|
| 205 | |
---|
| 206 | [{f}] |
---|
| 207 | default=json |
---|
| 208 | enum=json |
---|
| 209 | title=The optional f parameter |
---|
| 210 | 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. |
---|
| 211 | in=query |
---|
| 212 | required=false |
---|
| 213 | |
---|
| 214 | [conformsTo] |
---|
| 215 | rootUrl=http://www.opengis.net/spec/ogcapi-processes/1.0/conf/ |
---|
| 216 | rootUrl0=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/ |
---|
| 217 | link=core |
---|
| 218 | link_1=oas30 |
---|
| 219 | link_2=json |
---|
| 220 | link_3=job-list |
---|
| 221 | link_4=dismiss |
---|
| 222 | link_5=callback |
---|
| 223 | length=6 |
---|
| 224 | |
---|
| 225 | [exception] |
---|
| 226 | abstract=Exception |
---|
| 227 | type=application/json |
---|
| 228 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/NotFound.yaml |
---|
| 229 | default_schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ServerError.yaml |
---|
| 230 | |
---|
| 231 | [responses] |
---|
| 232 | length=5 |
---|
| 233 | code=404 |
---|
| 234 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/NotFound.yaml |
---|
| 235 | type=application/json |
---|
| 236 | title=NotFound |
---|
| 237 | code_1=500 |
---|
| 238 | schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ServerError.yaml |
---|
| 239 | type_1=application/json |
---|
| 240 | title_1=ServerError |
---|
| 241 | code_2=400 |
---|
| 242 | schema_2=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/InvalidParameter.yaml |
---|
| 243 | type_2=appliction/json |
---|
| 244 | title_2=InvalidParameter |
---|
| 245 | code_3=405 |
---|
| 246 | schema_3=https://github.com/opengeospatial/wps-rest-binding/blob/master/core/openapi/responses/NotAllowed.yaml |
---|
| 247 | type_3=appliction/json |
---|
| 248 | title_3=NotAllowed |
---|
| 249 | code_4=406 |
---|
| 250 | schema_4=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/NotSupported.yaml |
---|
| 251 | type_4=appliction/json |
---|
| 252 | title_4=NotSupported |
---|
| 253 | |
---|
| 254 | [callbacks] |
---|
| 255 | length=3 |
---|
| 256 | state=jobSuccess |
---|
| 257 | uri=successUri |
---|
| 258 | schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/result.yaml |
---|
| 259 | type=application/json |
---|
| 260 | title=Results received successfully |
---|
| 261 | state_1=jobInProgress |
---|
| 262 | uri_1=inProgressUri |
---|
| 263 | schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/statusInfo.yaml |
---|
| 264 | type_1=application/json |
---|
| 265 | title_1=Results received successfully |
---|
| 266 | state_2=jobFailed |
---|
| 267 | uri_2=failedUrii |
---|
| 268 | schema_2=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/exception.yaml |
---|
| 269 | type_2=application/json |
---|
| 270 | title_2=Exception received successfully |
---|
| 271 | |
---|
| 272 | [links_title] |
---|
| 273 | self=View this document in JSON. |
---|
| 274 | alternate=View the alternative version in HTML. |
---|
| 275 | conformance=View the specifications that the link’s context conforms to. |
---|
| 276 | service-desc=View the service description. |
---|
| 277 | service-doc=View service documentation. |
---|
| 278 | processes=View the list of processes the API offers. |
---|
| 279 | results=View the results of a process. |
---|
| 280 | status=View the current status of a job execution. |
---|
| 281 | execute=View the execution endpoint of a process. |
---|
| 282 | |
---|
| 283 | [provider_alt] |
---|
| 284 | addressDeliveryPoint=streetAddress |
---|
| 285 | addressCity=addressLocality |
---|
| 286 | addressAdministrativeArea=addressRegion |
---|
| 287 | addressPostalCode=postalCode |
---|
| 288 | addressCountry=addressCountry |
---|
| 289 | addressElectronicMailAddress=email |
---|
| 290 | phoneVoice=telephone |
---|
| 291 | phoneFacsimile=faxNumber |
---|
| 292 | hoursOfService=hoursAvailable |
---|
| 293 | contactInstructions=contactOption |
---|
| 294 | |
---|