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

[openapi]
use_content=false
rootUrl=http://localhost/ogc-api
links=/,/api,/conformance,/processes,/jobs
paths=/root,/api,/conformance,/processes,/processes/{processID},/jobs,/jobs/{jobID},/jobs/{jobID}/results
parameters=processID,jobID,resultID
version=3.0.2
license_name=OGC license
license_url=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/LICENSE
full_html_support=true
partial_html_support=true
wsUrl=ws://localhost:8888/
publisherUrl=http://localhost/cgi-bin/publish.py?jobid=

[/]
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/ogcapi-processes/master/core/openapi/responses/LandingPage.yaml

[/index.html]
rel=alternate
type=text/html

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

[/api.html]
rel=service-doc
type=text/hml

[api.html]
href=http://localhost/swagger-ui/oapip/

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

[/conformance]
rel=conformance
type=application/json
title=OGC API - Processes 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/ogcapi-processes/master/core/openapi/responses/ConformanceDeclaration.yaml

[/conformance.html]
rel=alternate
type=text/hml

[/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/ogcapi-processes/master/core/openapi/responses/ProcessList.yaml

[/processes.html]
rel=alternate
type=text/hml

[processes/{processID}]
length=2
method=get
title=retrieve a process description
abstract=A process description.
tags=ProcessDescription
tags_description=
schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ProcessDescription.yaml
ecode=404
parameters=/components/parameters/processID
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/ogcapi-processes/master/core/openapi/responses/ExecuteSync.yaml
parameters_1=/components/parameters/processID
ecode_1=400,404,500
eschema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteAsync.yaml

[/jobs]
rel=canonical
type=application/json
title=Job Management

[jobs]
length=1
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/ogcapi-processes/master/core/openapi/responses/JobList.yaml
parameters=
ecode=404,500
method_1=post
title_1=execute a job
abstract_1=An execute endpoint.
tags_1=ExecuteEndpoint
tags_description_1=
schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteSync.yaml
parameters_1=
ecode_1=400,404,500
eschema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteAsync.yaml
ep=,/components/parameters/oas-header1

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

[/jobs.html]
rel=alternate
type=text/hml

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

[jobs/{jobID}]
length=2
method=get
title=The status of a job.
abstract=The status of a job.
tags=GetStatus
tags_description=
schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml
parameters=/components/parameters/jobID
method_1=delete
title_1=Cancel a job
abstract_1=Cancel the job execution.
tags_1=Dismiss
tags_description_1=Cancel a job execution
schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml
parameters_1=/components/parameters/jobID
ecode_1=404,500

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

[jobs/{jobID}/results]
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/ogcapi-processes/master/core/openapi/responses/Results.yaml
parameters=/components/parameters/jobID
ecode=404,500
ep=,/components/parameters/oas-header2

[{processID}]
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

[conformsTo]
rootUrl=http://www.opengis.net/spec/ogcapi-processes/1.0/req/
rootUrl0=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/
link=core
link_1=oas30
link_2=json
link_3=job-list
link_4=dismiss
link_5=callback
link_6=ogc-process-description
link_7=html
length=8

[exception]
abstract=Exception
type=application/json
schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/responses/NotFound.yaml
default_schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml

[responses]
length=5
code=404
schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotFound.yaml
type=application/json
title=NotFound
code_1=500
schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml
type_1=application/json
title_1=ServerError
code_2=400
schema_2=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/InvalidParameter.yaml
type_2=appliction/json
title_2=InvalidParameter
code_3=405
schema_3=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotAllowed.yaml
type_3=appliction/json
title_3=NotAllowed
code_4=406
schema_4=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotSupported.yaml
type_4=appliction/json
title_4=NotSupported

[callbacks]
length=3
state=jobSuccess
uri=successUri
schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/result.yaml
type=application/json
title=Results received successfully
state_1=jobInProgress
uri_1=inProgressUri
schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/statusInfo.yaml
type_1=application/json
title_1=Status received successfully
state_2=jobFailed
uri_2=failedUri
schema_2=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/exception.yaml
type_2=application/json
title_2=Exception received successfully

[links_title]
self=View this document in JSON.
alternate=View the alternative version in HTML.
conformance=View the specifications that the link’s context conforms to.
service-desc=View the service description.
service-doc=View service documentation.
processes=View the list of processes the API offers.
results=View the results of a process.
status=View the current status of a job execution.
execute=View the execution endpoint of a process.

[provider_alt]
addressDeliveryPoint=streetAddress
addressCity=addressLocality
addressAdministrativeArea=addressRegion
addressPostalCode=postalCode
addressCountry=addressCountry
addressElectronicMailAddress=email
phoneVoice=telephone
phoneFacsimile=faxNumber
hoursOfService=hoursAvailable
contactInstructions=contactOption