[959] | 1 | [openapi] |
---|
[968] | 2 | use_content=false |
---|
| 3 | rootUrl=http://localhost/ogc-api |
---|
[985] | 4 | links=/,/api,/conformance,/processes,/jobs |
---|
[986] | 5 | paths=/root,/api,/conformance,/processes,/processes/{processID},/jobs,/jobs/{jobID},/jobs/{jobID}/results |
---|
| 6 | parameters=processID,jobID,resultID |
---|
[968] | 7 | version=3.0.2 |
---|
| 8 | license_name=OGC license |
---|
[986] | 9 | license_url=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/LICENSE |
---|
| 10 | full_html_support=true |
---|
[968] | 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 | |
---|
[986] | 86 | [processes/{processID}] |
---|
| 87 | length=2 |
---|
[959] | 88 | method=get |
---|
| 89 | title=retrieve a process description |
---|
| 90 | abstract=A process description. |
---|
| 91 | tags=ProcessDescription |
---|
| 92 | tags_description= |
---|
[985] | 93 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ProcessDescription.yaml |
---|
[968] | 94 | ecode=404 |
---|
[986] | 95 | parameters=/components/parameters/processID |
---|
[959] | 96 | method_1=post |
---|
| 97 | title_1=execute a job |
---|
| 98 | abstract_1=An execute endpoint. |
---|
| 99 | tags_1=Execute Endpoint |
---|
| 100 | tags_description_1= |
---|
[985] | 101 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteSync.yaml |
---|
[986] | 102 | parameters_1=/components/parameters/processID |
---|
[968] | 103 | ecode_1=400,404,500 |
---|
[985] | 104 | eschema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteAsync.yaml |
---|
[959] | 105 | |
---|
[985] | 106 | [/jobs] |
---|
| 107 | rel=canonical |
---|
| 108 | type=application/json |
---|
[986] | 109 | title=Job Management |
---|
[985] | 110 | |
---|
| 111 | [jobs] |
---|
[986] | 112 | length=1 |
---|
[985] | 113 | method=get |
---|
| 114 | title=retrieve a list of jobs run |
---|
| 115 | abstract=A list of jobs run. |
---|
| 116 | tags=JobList |
---|
| 117 | tags_description= |
---|
| 118 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/JobList.yaml |
---|
| 119 | parameters= |
---|
| 120 | ecode=404,500 |
---|
| 121 | method_1=post |
---|
| 122 | title_1=execute a job |
---|
| 123 | abstract_1=An execute endpoint. |
---|
| 124 | tags_1=ExecuteEndpoint |
---|
| 125 | tags_description_1= |
---|
| 126 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteSync.yaml |
---|
| 127 | parameters_1= |
---|
| 128 | ecode_1=400,404,500 |
---|
| 129 | eschema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteAsync.yaml |
---|
| 130 | ep=,/components/parameters/oas-header1 |
---|
| 131 | |
---|
[959] | 132 | [requestBody] |
---|
| 133 | abstract=Mandatory execute request in JSON format |
---|
| 134 | type=application/json |
---|
[985] | 135 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/execute.yaml |
---|
[959] | 136 | |
---|
[985] | 137 | [/jobs.html] |
---|
| 138 | rel=alternate |
---|
| 139 | type=text/hml |
---|
| 140 | |
---|
| 141 | [/jobs/{jobID}] |
---|
| 142 | rel=canonical |
---|
| 143 | type=application/json |
---|
| 144 | title=Status |
---|
[968] | 145 | |
---|
[985] | 146 | [jobs/{jobID}] |
---|
| 147 | length=2 |
---|
| 148 | method=get |
---|
| 149 | title=The status of a job. |
---|
| 150 | abstract=The status of a job. |
---|
| 151 | tags=GetStatus |
---|
| 152 | tags_description= |
---|
| 153 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml |
---|
| 154 | parameters=/components/parameters/jobID |
---|
| 155 | method_1=delete |
---|
| 156 | title_1=Cancel a job |
---|
| 157 | abstract_1=Cancel the job execution. |
---|
| 158 | tags_1=Dismiss |
---|
| 159 | tags_description_1=Cancel a job execution |
---|
| 160 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml |
---|
| 161 | parameters_1=/components/parameters/jobID |
---|
| 162 | ecode_1=404,500 |
---|
| 163 | |
---|
| 164 | [/jobs/{jobID}/results] |
---|
| 165 | rel=canonical |
---|
| 166 | type=application/json |
---|
| 167 | title=Get Result |
---|
| 168 | |
---|
| 169 | [jobs/{jobID}/results] |
---|
| 170 | method=get |
---|
| 171 | title=The result of a job execution. |
---|
| 172 | abstract=The result of a job execution. |
---|
| 173 | tags=GetResult |
---|
| 174 | tags_description= |
---|
| 175 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Results.yaml |
---|
| 176 | parameters=/components/parameters/jobID |
---|
| 177 | ecode=404,500 |
---|
| 178 | ep=,/components/parameters/oas-header2 |
---|
| 179 | |
---|
[986] | 180 | [{processID}] |
---|
[959] | 181 | type=string |
---|
| 182 | title=The id of a process |
---|
| 183 | abstract=The id of a process |
---|
| 184 | in=path |
---|
| 185 | required=true |
---|
| 186 | example=buffer |
---|
| 187 | |
---|
| 188 | [{jobID}] |
---|
| 189 | type=string |
---|
| 190 | title=The id of a job |
---|
| 191 | abstract=The id of a job |
---|
| 192 | in=path |
---|
| 193 | required=true |
---|
| 194 | |
---|
| 195 | [{resultID}] |
---|
| 196 | type=string |
---|
| 197 | title=The id of an output |
---|
| 198 | abstract=The id of an output |
---|
| 199 | in=path |
---|
| 200 | required=true |
---|
| 201 | |
---|
| 202 | [{f}] |
---|
| 203 | default=json |
---|
| 204 | enum=json |
---|
| 205 | title=The optional f parameter |
---|
| 206 | 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. |
---|
| 207 | in=query |
---|
| 208 | required=false |
---|
| 209 | |
---|
[968] | 210 | [conformsTo] |
---|
[985] | 211 | rootUrl=http://www.opengis.net/spec/ogcapi-processes/1.0/req/ |
---|
[968] | 212 | rootUrl0=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/ |
---|
[959] | 213 | link=core |
---|
| 214 | link_1=oas30 |
---|
| 215 | link_2=json |
---|
[968] | 216 | link_3=job-list |
---|
| 217 | link_4=dismiss |
---|
| 218 | link_5=callback |
---|
[985] | 219 | link_6=ogc-process-description |
---|
| 220 | link_7=html |
---|
| 221 | length=8 |
---|
[959] | 222 | |
---|
| 223 | [exception] |
---|
| 224 | abstract=Exception |
---|
| 225 | type=application/json |
---|
[985] | 226 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/responses/NotFound.yaml |
---|
| 227 | default_schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml |
---|
[959] | 228 | |
---|
[968] | 229 | [responses] |
---|
| 230 | length=5 |
---|
| 231 | code=404 |
---|
[985] | 232 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotFound.yaml |
---|
[968] | 233 | type=application/json |
---|
| 234 | title=NotFound |
---|
| 235 | code_1=500 |
---|
[985] | 236 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml |
---|
[968] | 237 | type_1=application/json |
---|
| 238 | title_1=ServerError |
---|
| 239 | code_2=400 |
---|
[985] | 240 | schema_2=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/InvalidParameter.yaml |
---|
[968] | 241 | type_2=appliction/json |
---|
| 242 | title_2=InvalidParameter |
---|
| 243 | code_3=405 |
---|
[985] | 244 | schema_3=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotAllowed.yaml |
---|
[968] | 245 | type_3=appliction/json |
---|
| 246 | title_3=NotAllowed |
---|
| 247 | code_4=406 |
---|
[985] | 248 | schema_4=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotSupported.yaml |
---|
[968] | 249 | type_4=appliction/json |
---|
| 250 | title_4=NotSupported |
---|
| 251 | |
---|
| 252 | [callbacks] |
---|
| 253 | length=3 |
---|
| 254 | state=jobSuccess |
---|
| 255 | uri=successUri |
---|
[985] | 256 | schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/result.yaml |
---|
[968] | 257 | type=application/json |
---|
| 258 | title=Results received successfully |
---|
| 259 | state_1=jobInProgress |
---|
| 260 | uri_1=inProgressUri |
---|
[985] | 261 | schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/statusInfo.yaml |
---|
[968] | 262 | type_1=application/json |
---|
[986] | 263 | title_1=Status received successfully |
---|
[968] | 264 | state_2=jobFailed |
---|
[986] | 265 | uri_2=failedUri |
---|
[985] | 266 | schema_2=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/exception.yaml |
---|
[968] | 267 | type_2=application/json |
---|
| 268 | title_2=Exception received successfully |
---|
| 269 | |
---|
| 270 | [links_title] |
---|
| 271 | self=View this document in JSON. |
---|
| 272 | alternate=View the alternative version in HTML. |
---|
| 273 | conformance=View the specifications that the link’s context conforms to. |
---|
| 274 | service-desc=View the service description. |
---|
| 275 | service-doc=View service documentation. |
---|
| 276 | processes=View the list of processes the API offers. |
---|
| 277 | results=View the results of a process. |
---|
| 278 | status=View the current status of a job execution. |
---|
| 279 | execute=View the execution endpoint of a process. |
---|
| 280 | |
---|
| 281 | [provider_alt] |
---|
| 282 | addressDeliveryPoint=streetAddress |
---|
| 283 | addressCity=addressLocality |
---|
| 284 | addressAdministrativeArea=addressRegion |
---|
| 285 | addressPostalCode=postalCode |
---|
| 286 | addressCountry=addressCountry |
---|
| 287 | addressElectronicMailAddress=email |
---|
| 288 | phoneVoice=telephone |
---|
| 289 | phoneFacsimile=faxNumber |
---|
| 290 | hoursOfService=hoursAvailable |
---|
| 291 | contactInstructions=contactOption |
---|
| 292 | |
---|