source: trunk/docker/oas.cfg @ 985

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

Move jobs management and execution endpoint from /processes/{procssId}/jobs to /jobs

File size: 10.4 KB
Line 
1[openapi]
2use_content=false
3rootUrl=http://localhost/ogc-api
4links=/,/api,/conformance,/processes,/jobs
5paths=/root,/api,/conformance,/processes,/processes/{id},/jobs,/jobs/{jobID},/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/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/{id}]
87method=get
88title=retrieve a process description
89abstract=A process description.
90tags=ProcessDescription
91tags_description=
92schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/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/opengeospatial/ogcapi-processes/master/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/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteSync.yaml
118parameters_1=/components/parameters/id
119ecode_1=400,404,500
120eschema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteAsync.yaml
121ep=,/components/parameters/oas-header1
122
123[/jobs]
124rel=canonical
125type=application/json
126title=Execute Endpoint
127
128[jobs]
129length=2
130method=get
131title=retrieve a list of jobs run
132abstract=A list of jobs run.
133tags=JobList
134tags_description=
135schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/JobList.yaml
136parameters=
137ecode=404,500
138method_1=post
139title_1=execute a job
140abstract_1=An execute endpoint.
141tags_1=ExecuteEndpoint
142tags_description_1=
143schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteSync.yaml
144parameters_1=
145ecode_1=400,404,500
146eschema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteAsync.yaml
147ep=,/components/parameters/oas-header1
148
149[requestBody]
150abstract=Mandatory execute request in JSON format
151type=application/json
152schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/execute.yaml
153
154[/jobs.html]
155rel=alternate
156type=text/hml
157
158[/processes/{id}/jobs/{jobID}]
159rel=canonical
160type=application/json
161title=Status
162
163[processes/{id}/jobs/{jobID}]
164length=2
165method=get
166title=The status of a job.
167abstract=The status of a job.
168tags=GetStatus
169tags_description=
170schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml
171parameters=/components/parameters/id,/components/parameters/jobID
172method_1=delete
173title_1=Cancel a job
174abstract_1=Cancel the job execution.
175tags_1=Dismiss
176tags_description_1=Cencel a job execution
177schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml
178parameters_1=/components/parameters/id,/components/parameters/jobID
179ecode_1=404,500
180
181[/jobs/{jobID}]
182rel=canonical
183type=application/json
184title=Status
185
186[jobs/{jobID}]
187length=2
188method=get
189title=The status of a job.
190abstract=The status of a job.
191tags=GetStatus
192tags_description=
193schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml
194parameters=/components/parameters/jobID
195method_1=delete
196title_1=Cancel a job
197abstract_1=Cancel the job execution.
198tags_1=Dismiss
199tags_description_1=Cancel a job execution
200schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml
201parameters_1=/components/parameters/jobID
202ecode_1=404,500
203
204
205[/processes/{id}/jobs/{jobID}/results]
206rel=canonical
207type=application/json
208title=Get Result
209
210[processes/{id}/jobs/{jobID}/results]
211method=get
212title=The result of a job execution.
213abstract=The result of a job execution.
214tags=GetResult
215tags_description=
216schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Results.yaml
217parameters=/components/parameters/id,/components/parameters/jobID
218ecode=404,500
219ep=,/components/parameters/oas-header2
220
221[/jobs/{jobID}/results]
222rel=canonical
223type=application/json
224title=Get Result
225
226[jobs/{jobID}/results]
227method=get
228title=The result of a job execution.
229abstract=The result of a job execution.
230tags=GetResult
231tags_description=
232schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Results.yaml
233parameters=/components/parameters/jobID
234ecode=404,500
235ep=,/components/parameters/oas-header2
236
237[/processes/{id}/jobs/{jobID}/result/{resultID}]
238rel=canonical
239type=application/json
240title=Get Result
241
242[processes/{id}/jobs/{jobID}/result/{resultID}]
243method=get
244title=The result of a job execution.
245abstract=The result of a job execution.
246tags=GetResult
247tags_description=
248schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/valueType.yaml
249parameters=/components/parameters/id,/components/parameters/jobID,/components/parameters/resultID
250ep=,/components/parameters/oas-header2
251
252
253[{id}]
254type=string
255title=The id of a process
256abstract=The id of a process
257in=path
258required=true
259example=buffer
260
261[{jobID}]
262type=string
263title=The id of a job
264abstract=The id of a job
265in=path
266required=true
267
268[{resultID}]
269type=string
270title=The id of an output
271abstract=The id of an output
272in=path
273required=true
274
275[{f}]
276default=json
277enum=json
278title=The optional f parameter
279abstract=The optional f parameter indicates the output format which the server shall provide as part of the response document.  The default format is JSON.
280in=query
281required=false
282
283[conformsTo]
284rootUrl=http://www.opengis.net/spec/ogcapi-processes/1.0/req/
285rootUrl0=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/
286link=core
287link_1=oas30
288link_2=json
289link_3=job-list
290link_4=dismiss
291link_5=callback
292link_6=ogc-process-description
293link_7=html
294length=8
295
296[exception]
297abstract=Exception
298type=application/json
299schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/responses/NotFound.yaml
300default_schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml
301
302[responses]
303length=5
304code=404
305schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotFound.yaml
306type=application/json
307title=NotFound
308code_1=500
309schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml
310type_1=application/json
311title_1=ServerError
312code_2=400
313schema_2=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/InvalidParameter.yaml
314type_2=appliction/json
315title_2=InvalidParameter
316code_3=405
317schema_3=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotAllowed.yaml
318type_3=appliction/json
319title_3=NotAllowed
320code_4=406
321schema_4=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotSupported.yaml
322type_4=appliction/json
323title_4=NotSupported
324
325[callbacks]
326length=3
327state=jobSuccess
328uri=successUri
329schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/result.yaml
330type=application/json
331title=Results received successfully
332state_1=jobInProgress
333uri_1=inProgressUri
334schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/statusInfo.yaml
335type_1=application/json
336title_1=Results received successfully
337state_2=jobFailed
338uri_2=failedUrii
339schema_2=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/exception.yaml
340type_2=application/json
341title_2=Exception received successfully
342
343[links_title]
344self=View this document in JSON.
345alternate=View the alternative version in HTML.
346conformance=View the specifications that the link’s context conforms to.
347service-desc=View the service description.
348service-doc=View service documentation.
349processes=View the list of processes the API offers.
350results=View the results of a process.
351status=View the current status of a job execution.
352execute=View the execution endpoint of a process.
353
354[provider_alt]
355addressDeliveryPoint=streetAddress
356addressCity=addressLocality
357addressAdministrativeArea=addressRegion
358addressPostalCode=postalCode
359addressCountry=addressCountry
360addressElectronicMailAddress=email
361phoneVoice=telephone
362phoneFacsimile=faxNumber
363hoursOfService=hoursAvailable
364contactInstructions=contactOption
365
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