source: trunk/docker/oas.cfg @ 961

[openapi]
rootUrl=http://localhost/cgi-bin/zoo_loader.cgi
links=/,/api,/conformance,/processes
paths=/root,/api,/conformance,/processes,/processes/{id},/processes/{id}/jobs,/processes/{id}/jobs/{jobID},/processes/{id}/jobs/{jobID}/result
parameters=id,jobID,resultID
header_parameters=oas-header1,oas-header2
version=3.0.1

[oas-header1]
in=header
name=Prefer
type=string
required=false
enum=respond-async

[oas-header2]
in=header
name=Prefer
type=string
required=false
enum=return=representation,return=minimal

[/]
rel=self
type=application/json
title=this document

[root]
method=get
title=landing page of this API
abstract=The landing page provides links to the API definition, the Conformance statements and the metadata about the processes offered by this service.
tags=Home
tags_description=
schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/root.yaml

[/api]
rel=service
type=application/openapi+json;version=3.0
title=the API definition

[api]
method=get
title=This document
abstract=This document
tags=API
tags_description=
schema=

[/conformance]
rel=conformance
type=application/json
title=WPS 2.0 REST/JSON Binding Extension conformance classes implemented by this server

[conformance]
method=get
title=information about standards that this API conforms to
abstract==list all requirements classes specified in a standard (e.g., WPS REST/JSON Binding Core) that the server conforms to
tags=Conformance
tags_description=
schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/req-classes.yaml

[/processes]
rel=processes
type=application/json
title=The processes offered by this server

[processes]
method=get
title=retrieve available processes
abstract=Information about the available processes
tags=GetCapabilities
tags_description=
schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/processCollection.yaml

[processes/{id}]
method=get
title=retrieve a process description
abstract=A process description.
tags=ProcessDescription
tags_description=
schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/process.yaml
parameters=/components/parameters/id


[/processes/{id}/jobs]
rel=canonical
type=application/json
title=Process Description

[processes/{id}/jobs]
length=2
method=get
title=retrieve a list of jobs run
abstract=A list of jobs run.
tags=JobList
tags_description=
schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/jobCollection.yaml
parameters=/components/parameters/id
method_1=post
title_1=execute a job
abstract_1=An execute endpoint.
tags_1=Execute Endpoint
tags_description_1=
schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/result.yaml
parameters_1=/components/parameters/id,/components/parameters/oas-header1

[requestBody]
abstract=Mandatory execute request in JSON format
type=application/json
schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/execute.yaml

[/processes/{id}/jobs/{jobID}]
rel=canonical
type=application/json
title=Status

[processes/{id}/jobs/{jobID}]
method=get
title=The status of a job.
abstract=The status of a job.
tags=GetStatus
tags_description=
schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/statusInfo.yaml
parameters=/components/parameters/id,/components/parameters/jobID

[/processes/{id}/jobs/{jobID}/result]
rel=canonical
type=application/json
title=Get Result

[processes/{id}/jobs/{jobID}/result]
method=get
title=The result of a job execution.
abstract=The result of a job execution.
tags=GetResult
tags_description=
schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/result.yaml
parameters=/components/parameters/id,/components/parameters/jobID
ep=,/components/parameters/oas-header2

[/processes/{id}/jobs/{jobID}/result/{resultID}]
rel=canonical
type=application/json
title=Get Result

[processes/{id}/jobs/{jobID}/result/{resultID}]
method=get
title=The result of a job execution.
abstract=The result of a job execution.
tags=GetResult
tags_description=
schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/valueType.yaml
parameters=/components/parameters/id,/components/parameters/jobID,/components/parameters/resultID,/components/parameters/oas-header2


[{id}]
type=string
title=The id of a process
abstract=The id of a process
in=path
required=true
example=buffer

[{jobID}]
type=string
title=The id of a job
abstract=The id of a job
in=path
required=true

[{resultID}]
type=string
title=The id of an output
abstract=The id of an output
in=path
required=true

[{f}]
default=json
enum=json
title=The optional f parameter
abstract=The optional f parameter indicates the output format which the server shall provide as part of the response document.  The default format is JSON.
in=query
required=false

[conformTo]
rootUrl=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/
link=core
link_1=oas30
link_2=json
length=3

[exception]
abstract=Exception
type=application/json
schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/exception.yaml