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

Last change on this file since 950 was 950, checked in by djay, 11 months ago

Add documentation for the oas.cfg file and clean it a bit.

  • Property svn:keywords set to Id
File size: 5.2 KB
Line 
1[openapi]
2rootUrl=https://demo.mapmint.com/wps3/
3links=/,/api,/conformance,/processes
4paths=/root,/api,/conformance,/processes,/processes/{id},/processes/{id}/jobs,/processes/{id}/jobs/{jobID},/processes/{id}/jobs/{jobID}/result
5parameters=id,jobID,resultID
6header_parameters=oas-header1,oas-header2
7version=3.0.1
8
9[oas-header1]
10in=header
11name=Prefer
12type=string
13required=false
14enum=respond-async
15
16[oas-header2]
17in=header
18name=Prefer
19type=string
20required=false
21enum=return=representation,return=minimal
22
23[/]
24rel=self
25type=application/json
26title=this document
27
28[root]
29method=get
30title=landing page of this API
31abstract=The landing page provides links to the API definition, the Conformance statements and the metadata about the processes offered by this service.
32tags=Home
33tags_description=
34schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/root.yaml
35
36[/api]
37rel=service
38type=application/openapi+json;version=3.0
39title=the API definition
40
41[api]
42method=get
43title=This document
44abstract=This document
45tags=API
46tags_description=
47schema=
48
49[/conformance]
50rel=conformance
51type=application/json
52title=WPS 2.0 REST/JSON Binding Extension conformance classes implemented by this server
53
54[conformance]
55method=get
56title=information about standards that this API conforms to
57abstract==list all requirements classes specified in a standard (e.g., WPS REST/JSON Binding Core) that the server conforms to
58tags=Conformance
59tags_description=
60schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/req-classes.yaml
61
62[/processes]
63rel=processes
64type=application/json
65title=The processes offered by this server
66
67[processes]
68method=get
69title=retrieve available processes
70abstract=Information about the available processes
71tags=GetCapabilities
72tags_description=
73schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/processCollection.yaml
74
75[processes/{id}]
76method=get
77title=retrieve a process description
78abstract=A process description.
79tags=ProcessDescription
80tags_description=
81schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/process.yaml
82parameters=/components/parameters/id
83
84
85[/processes/{id}/jobs]
86rel=canonical
87type=application/json
88title=Process Description
89
90[processes/{id}/jobs]
91length=2
92method=get
93title=retrieve a list of jobs run
94abstract=A list of jobs run.
95tags=JobList
96tags_description=
97schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/jobCollection.yaml
98parameters=/components/parameters/id
99method_1=post
100title_1=execute a job
101abstract_1=An execute endpoint.
102tags_1=Execute Endpoint
103tags_description_1=
104schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/result.yaml
105parameters_1=/components/parameters/id,/components/parameters/oas-header1
106
107[requestBody]
108abstract=Mandatory execute request in JSON format
109type=application/json
110schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/execute.yaml
111
112[/processes/{id}/jobs/{jobID}]
113rel=canonical
114type=application/json
115title=Status
116
117[processes/{id}/jobs/{jobID}]
118method=get
119title=The status of a job.
120abstract=The status of a job.
121tags=GetStatus
122tags_description=
123schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/statusInfo.yaml
124parameters=/components/parameters/id,/components/parameters/jobID
125
126[/processes/{id}/jobs/{jobID}/result]
127rel=canonical
128type=application/json
129title=Get Result
130
131[processes/{id}/jobs/{jobID}/result]
132method=get
133title=The result of a job execution.
134abstract=The result of a job execution.
135tags=GetResult
136tags_description=
137schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/result.yaml
138parameters=/components/parameters/id,/components/parameters/jobID
139ep=,/components/parameters/oas-header2
140
141[/processes/{id}/jobs/{jobID}/result/{resultID}]
142rel=canonical
143type=application/json
144title=Get Result
145
146[processes/{id}/jobs/{jobID}/result/{resultID}]
147method=get
148title=The result of a job execution.
149abstract=The result of a job execution.
150tags=GetResult
151tags_description=
152schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/valueType.yaml
153parameters=/components/parameters/id,/components/parameters/jobID,/components/parameters/resultID,/components/parameters/oas-header2
154
155
156[{id}]
157type=string
158title=The id of a process
159abstract=The id of a process
160in=path
161required=true
162example=buffer
163
164[{jobID}]
165type=string
166title=The id of a job
167abstract=The id of a job
168in=path
169required=true
170
171[{resultID}]
172type=string
173title=The id of an output
174abstract=The id of an output
175in=path
176required=true
177
178[{f}]
179default=json
180enum=json
181title=The optional f parameter
182abstract=The optional f parameter indicates the output format which the server shall provide as part of the response document.  The default format is JSON.
183in=query
184required=false
185
186[conformTo]
187rootUrl=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/
188link=core
189link_1=oas30
190link_2=json
191length=3
192
193[exception]
194abstract=Exception
195type=application/json
196schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/exception.yaml
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