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