[959] | 1 | [openapi] |
---|
[968] | 2 | use_content=false |
---|
| 3 | rootUrl=http://localhost/ogc-api |
---|
[985] | 4 | links=/,/api,/conformance,/processes,/jobs |
---|
| 5 | paths=/root,/api,/conformance,/processes,/processes/{id},/jobs,/jobs/{jobID},/jobs/{jobID}/results |
---|
[959] | 6 | parameters=id,jobID,resultID |
---|
[968] | 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=ws://localhost:8888/ |
---|
| 13 | publisherUrl=http://localhost/cgi-bin/publish.py?jobid= |
---|
[959] | 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= |
---|
[985] | 26 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/LandingPage.yaml |
---|
[959] | 27 | |
---|
[968] | 28 | [/index.html] |
---|
| 29 | rel=alternate |
---|
| 30 | type=text/html |
---|
| 31 | |
---|
[959] | 32 | [/api] |
---|
[968] | 33 | rel=service-desc |
---|
[959] | 34 | type=application/openapi+json;version=3.0 |
---|
| 35 | title=the API definition |
---|
| 36 | |
---|
[968] | 37 | [/api.html] |
---|
| 38 | rel=service-doc |
---|
| 39 | type=text/hml |
---|
| 40 | |
---|
| 41 | [api.html] |
---|
[984] | 42 | href=http://localhost/swagger-ui/oapip/ |
---|
[968] | 43 | |
---|
[959] | 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 |
---|
[968] | 55 | title=OGC API - Processes conformance classes implemented by this server |
---|
[959] | 56 | |
---|
| 57 | [conformance] |
---|
| 58 | method=get |
---|
| 59 | title=information about standards that this API conforms to |
---|
[968] | 60 | abstract=list all requirements classes specified in a standard (e.g., WPS REST/JSON Binding Core) that the server conforms to |
---|
[959] | 61 | tags=Conformance |
---|
| 62 | tags_description= |
---|
[985] | 63 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ConformanceDeclaration.yaml |
---|
[959] | 64 | |
---|
[968] | 65 | [/conformance.html] |
---|
| 66 | rel=alternate |
---|
| 67 | type=text/hml |
---|
| 68 | |
---|
[959] | 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= |
---|
[985] | 80 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ProcessList.yaml |
---|
[959] | 81 | |
---|
[968] | 82 | [/processes.html] |
---|
| 83 | rel=alternate |
---|
| 84 | type=text/hml |
---|
| 85 | |
---|
[959] | 86 | [processes/{id}] |
---|
| 87 | method=get |
---|
| 88 | title=retrieve a process description |
---|
| 89 | abstract=A process description. |
---|
| 90 | tags=ProcessDescription |
---|
| 91 | tags_description= |
---|
[985] | 92 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ProcessDescription.yaml |
---|
[968] | 93 | ecode=404 |
---|
[959] | 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= |
---|
[985] | 109 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/JobList.yaml |
---|
[959] | 110 | parameters=/components/parameters/id |
---|
[968] | 111 | ecode=404,500 |
---|
[959] | 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= |
---|
[985] | 117 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteSync.yaml |
---|
[968] | 118 | parameters_1=/components/parameters/id |
---|
| 119 | ecode_1=400,404,500 |
---|
[985] | 120 | eschema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteAsync.yaml |
---|
[968] | 121 | ep=,/components/parameters/oas-header1 |
---|
[959] | 122 | |
---|
[985] | 123 | [/jobs] |
---|
| 124 | rel=canonical |
---|
| 125 | type=application/json |
---|
| 126 | title=Execute Endpoint |
---|
| 127 | |
---|
| 128 | [jobs] |
---|
| 129 | length=2 |
---|
| 130 | method=get |
---|
| 131 | title=retrieve a list of jobs run |
---|
| 132 | abstract=A list of jobs run. |
---|
| 133 | tags=JobList |
---|
| 134 | tags_description= |
---|
| 135 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/JobList.yaml |
---|
| 136 | parameters= |
---|
| 137 | ecode=404,500 |
---|
| 138 | method_1=post |
---|
| 139 | title_1=execute a job |
---|
| 140 | abstract_1=An execute endpoint. |
---|
| 141 | tags_1=ExecuteEndpoint |
---|
| 142 | tags_description_1= |
---|
| 143 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteSync.yaml |
---|
| 144 | parameters_1= |
---|
| 145 | ecode_1=400,404,500 |
---|
| 146 | eschema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteAsync.yaml |
---|
| 147 | ep=,/components/parameters/oas-header1 |
---|
| 148 | |
---|
[959] | 149 | [requestBody] |
---|
| 150 | abstract=Mandatory execute request in JSON format |
---|
| 151 | type=application/json |
---|
[985] | 152 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/execute.yaml |
---|
[959] | 153 | |
---|
[985] | 154 | [/jobs.html] |
---|
| 155 | rel=alternate |
---|
| 156 | type=text/hml |
---|
| 157 | |
---|
[959] | 158 | [/processes/{id}/jobs/{jobID}] |
---|
| 159 | rel=canonical |
---|
| 160 | type=application/json |
---|
| 161 | title=Status |
---|
| 162 | |
---|
| 163 | [processes/{id}/jobs/{jobID}] |
---|
[968] | 164 | length=2 |
---|
[959] | 165 | method=get |
---|
| 166 | title=The status of a job. |
---|
| 167 | abstract=The status of a job. |
---|
| 168 | tags=GetStatus |
---|
| 169 | tags_description= |
---|
[985] | 170 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml |
---|
[959] | 171 | parameters=/components/parameters/id,/components/parameters/jobID |
---|
[968] | 172 | method_1=delete |
---|
| 173 | title_1=Cancel a job |
---|
| 174 | abstract_1=Cancel the job execution. |
---|
| 175 | tags_1=Dismiss |
---|
| 176 | tags_description_1=Cencel a job execution |
---|
[985] | 177 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml |
---|
[968] | 178 | parameters_1=/components/parameters/id,/components/parameters/jobID |
---|
| 179 | ecode_1=404,500 |
---|
[959] | 180 | |
---|
[985] | 181 | [/jobs/{jobID}] |
---|
| 182 | rel=canonical |
---|
| 183 | type=application/json |
---|
| 184 | title=Status |
---|
[968] | 185 | |
---|
[985] | 186 | [jobs/{jobID}] |
---|
| 187 | length=2 |
---|
| 188 | method=get |
---|
| 189 | title=The status of a job. |
---|
| 190 | abstract=The status of a job. |
---|
| 191 | tags=GetStatus |
---|
| 192 | tags_description= |
---|
| 193 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml |
---|
| 194 | parameters=/components/parameters/jobID |
---|
| 195 | method_1=delete |
---|
| 196 | title_1=Cancel a job |
---|
| 197 | abstract_1=Cancel the job execution. |
---|
| 198 | tags_1=Dismiss |
---|
| 199 | tags_description_1=Cancel a job execution |
---|
| 200 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml |
---|
| 201 | parameters_1=/components/parameters/jobID |
---|
| 202 | ecode_1=404,500 |
---|
| 203 | |
---|
| 204 | |
---|
[968] | 205 | [/processes/{id}/jobs/{jobID}/results] |
---|
[959] | 206 | rel=canonical |
---|
| 207 | type=application/json |
---|
| 208 | title=Get Result |
---|
| 209 | |
---|
[968] | 210 | [processes/{id}/jobs/{jobID}/results] |
---|
[959] | 211 | method=get |
---|
| 212 | title=The result of a job execution. |
---|
| 213 | abstract=The result of a job execution. |
---|
| 214 | tags=GetResult |
---|
| 215 | tags_description= |
---|
[985] | 216 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Results.yaml |
---|
[959] | 217 | parameters=/components/parameters/id,/components/parameters/jobID |
---|
[968] | 218 | ecode=404,500 |
---|
[959] | 219 | ep=,/components/parameters/oas-header2 |
---|
| 220 | |
---|
[985] | 221 | [/jobs/{jobID}/results] |
---|
| 222 | rel=canonical |
---|
| 223 | type=application/json |
---|
| 224 | title=Get Result |
---|
| 225 | |
---|
| 226 | [jobs/{jobID}/results] |
---|
| 227 | method=get |
---|
| 228 | title=The result of a job execution. |
---|
| 229 | abstract=The result of a job execution. |
---|
| 230 | tags=GetResult |
---|
| 231 | tags_description= |
---|
| 232 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Results.yaml |
---|
| 233 | parameters=/components/parameters/jobID |
---|
| 234 | ecode=404,500 |
---|
| 235 | ep=,/components/parameters/oas-header2 |
---|
| 236 | |
---|
[959] | 237 | [/processes/{id}/jobs/{jobID}/result/{resultID}] |
---|
| 238 | rel=canonical |
---|
| 239 | type=application/json |
---|
| 240 | title=Get Result |
---|
| 241 | |
---|
| 242 | [processes/{id}/jobs/{jobID}/result/{resultID}] |
---|
| 243 | method=get |
---|
| 244 | title=The result of a job execution. |
---|
| 245 | abstract=The result of a job execution. |
---|
| 246 | tags=GetResult |
---|
| 247 | tags_description= |
---|
[985] | 248 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/valueType.yaml |
---|
[968] | 249 | parameters=/components/parameters/id,/components/parameters/jobID,/components/parameters/resultID |
---|
| 250 | ep=,/components/parameters/oas-header2 |
---|
[959] | 251 | |
---|
| 252 | |
---|
| 253 | [{id}] |
---|
| 254 | type=string |
---|
| 255 | title=The id of a process |
---|
| 256 | abstract=The id of a process |
---|
| 257 | in=path |
---|
| 258 | required=true |
---|
| 259 | example=buffer |
---|
| 260 | |
---|
| 261 | [{jobID}] |
---|
| 262 | type=string |
---|
| 263 | title=The id of a job |
---|
| 264 | abstract=The id of a job |
---|
| 265 | in=path |
---|
| 266 | required=true |
---|
| 267 | |
---|
| 268 | [{resultID}] |
---|
| 269 | type=string |
---|
| 270 | title=The id of an output |
---|
| 271 | abstract=The id of an output |
---|
| 272 | in=path |
---|
| 273 | required=true |
---|
| 274 | |
---|
| 275 | [{f}] |
---|
| 276 | default=json |
---|
| 277 | enum=json |
---|
| 278 | title=The optional f parameter |
---|
| 279 | 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. |
---|
| 280 | in=query |
---|
| 281 | required=false |
---|
| 282 | |
---|
[968] | 283 | [conformsTo] |
---|
[985] | 284 | rootUrl=http://www.opengis.net/spec/ogcapi-processes/1.0/req/ |
---|
[968] | 285 | rootUrl0=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/ |
---|
[959] | 286 | link=core |
---|
| 287 | link_1=oas30 |
---|
| 288 | link_2=json |
---|
[968] | 289 | link_3=job-list |
---|
| 290 | link_4=dismiss |
---|
| 291 | link_5=callback |
---|
[985] | 292 | link_6=ogc-process-description |
---|
| 293 | link_7=html |
---|
| 294 | length=8 |
---|
[959] | 295 | |
---|
| 296 | [exception] |
---|
| 297 | abstract=Exception |
---|
| 298 | type=application/json |
---|
[985] | 299 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/responses/NotFound.yaml |
---|
| 300 | default_schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml |
---|
[959] | 301 | |
---|
[968] | 302 | [responses] |
---|
| 303 | length=5 |
---|
| 304 | code=404 |
---|
[985] | 305 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotFound.yaml |
---|
[968] | 306 | type=application/json |
---|
| 307 | title=NotFound |
---|
| 308 | code_1=500 |
---|
[985] | 309 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml |
---|
[968] | 310 | type_1=application/json |
---|
| 311 | title_1=ServerError |
---|
| 312 | code_2=400 |
---|
[985] | 313 | schema_2=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/InvalidParameter.yaml |
---|
[968] | 314 | type_2=appliction/json |
---|
| 315 | title_2=InvalidParameter |
---|
| 316 | code_3=405 |
---|
[985] | 317 | schema_3=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotAllowed.yaml |
---|
[968] | 318 | type_3=appliction/json |
---|
| 319 | title_3=NotAllowed |
---|
| 320 | code_4=406 |
---|
[985] | 321 | schema_4=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotSupported.yaml |
---|
[968] | 322 | type_4=appliction/json |
---|
| 323 | title_4=NotSupported |
---|
| 324 | |
---|
| 325 | [callbacks] |
---|
| 326 | length=3 |
---|
| 327 | state=jobSuccess |
---|
| 328 | uri=successUri |
---|
[985] | 329 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/result.yaml |
---|
[968] | 330 | type=application/json |
---|
| 331 | title=Results received successfully |
---|
| 332 | state_1=jobInProgress |
---|
| 333 | uri_1=inProgressUri |
---|
[985] | 334 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/statusInfo.yaml |
---|
[968] | 335 | type_1=application/json |
---|
| 336 | title_1=Results received successfully |
---|
| 337 | state_2=jobFailed |
---|
| 338 | uri_2=failedUrii |
---|
[985] | 339 | schema_2=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/exception.yaml |
---|
[968] | 340 | type_2=application/json |
---|
| 341 | title_2=Exception received successfully |
---|
| 342 | |
---|
| 343 | [links_title] |
---|
| 344 | self=View this document in JSON. |
---|
| 345 | alternate=View the alternative version in HTML. |
---|
| 346 | conformance=View the specifications that the link’s context conforms to. |
---|
| 347 | service-desc=View the service description. |
---|
| 348 | service-doc=View service documentation. |
---|
| 349 | processes=View the list of processes the API offers. |
---|
| 350 | results=View the results of a process. |
---|
| 351 | status=View the current status of a job execution. |
---|
| 352 | execute=View the execution endpoint of a process. |
---|
| 353 | |
---|
| 354 | [provider_alt] |
---|
| 355 | addressDeliveryPoint=streetAddress |
---|
| 356 | addressCity=addressLocality |
---|
| 357 | addressAdministrativeArea=addressRegion |
---|
| 358 | addressPostalCode=postalCode |
---|
| 359 | addressCountry=addressCountry |
---|
| 360 | addressElectronicMailAddress=email |
---|
| 361 | phoneVoice=telephone |
---|
| 362 | phoneFacsimile=faxNumber |
---|
| 363 | hoursOfService=hoursAvailable |
---|
| 364 | contactInstructions=contactOption |
---|
| 365 | |
---|