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

Last change on this file since 949 was 949, checked in by djay, 10 months ago

Prototype implementation of the OGC API - Processing and other simplifications

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