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

Last change on this file was 986, checked in by djay, 7 months ago

Move the execute endpoint to /processes/{processID}. Fixes in oas.cfg: use opengeospatial/ogcapi-processes github repo for schemas URLs.

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

Search

Context Navigation

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