source: trunk/docker/oas.cfg @ 984

Last change on this file since 984 was 984, checked in by djay, 9 months ago

Take into account building ZOO-Project on ubuntu focal (cf. https://trac.osgeo.org/osgeolive/ticket/2282). Add the OTB and SAGA support to the Dockerfile to make the corresponding demos using docker WPS server. Add OGC API - Processes demo to the demos list.

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

Search

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png