source: trunk/zoo-project/zoo-kernel/oas.cfg @ 967

Last change on this file since 967 was 967, checked in by djay, 12 months ago

Add support for the two inputs / outputs syntaxes discussed in SWG in both the ZOO-Kernel and the HTML basic UI. Update documentation, add a section for the ZOO-API in Python language section. Rename variables in service.c to ease readabiliy.

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