Ignore:
Timestamp:
Oct 21, 2020, 6:31:09 PM (19 months ago)
Author:
djay
Message:

Update OGC API - Processes documentation and implementation, providing a browsable User Interface to Processes.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/zoo-project/zoo-kernel/oas.cfg

    r950 r962  
    11[openapi]
    2 rootUrl=https://demo.mapmint.com/wps3/
     2use_content=false
     3rootUrl=https://myserver/ogc-api
    34links=/,/api,/conformance,/processes
    4 paths=/root,/api,/conformance,/processes,/processes/{id},/processes/{id}/jobs,/processes/{id}/jobs/{jobID},/processes/{id}/jobs/{jobID}/result
     5paths=/root,/api,/conformance,/processes,/processes/{id},/processes/{id}/jobs,/processes/{id}/jobs/{jobID},/processes/{id}/jobs/{jobID}/results
    56parameters=id,jobID,resultID
    6 header_parameters=oas-header1,oas-header2
    7 version=3.0.1
    8 
    9 [oas-header1]
    10 in=header
    11 name=Prefer
    12 type=string
    13 required=false
    14 enum=respond-async
    15 
    16 [oas-header2]
    17 in=header
    18 name=Prefer
    19 type=string
    20 required=false
    21 enum=return=representation,return=minimal
     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=wss://demo.mapmint.com:4430/
     13publisherUrl=http://127.0.0.1/cgi-bin3/publish.py?jobid=
    2214
    2315[/]
     
    3224tags=Home
    3325tags_description=
    34 schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/root.yaml
     26schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/LandingPage.yaml
     27
     28[/index.html]
     29rel=alternate
     30type=text/html
    3531
    3632[/api]
    37 rel=service
     33rel=service-desc
    3834type=application/openapi+json;version=3.0
    3935title=the API definition
     36
     37[/api.html]
     38rel=service-doc
     39type=text/hml
     40
     41[api.html]
     42href=https://demo.mapmint.com/swagger-ui/ogc-api-processes/
    4043
    4144[api]
     
    5558method=get
    5659title=information about standards that this API conforms to
    57 abstract==list all requirements classes specified in a standard (e.g., WPS REST/JSON Binding Core) that the server conforms to
     60abstract=list all requirements classes specified in a standard (e.g., WPS REST/JSON Binding Core) that the server conforms to
    5861tags=Conformance
    5962tags_description=
    60 schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/req-classes.yaml
     63schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ConformanceDeclaration.yaml
     64
     65[/conformance.html]
     66rel=alternate
     67type=text/hml
    6168
    6269[/processes]
     
    7178tags=GetCapabilities
    7279tags_description=
    73 schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/processCollection.yaml
     80schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ProcessList.yaml
     81
     82[/processes.html]
     83rel=alternate
     84type=text/hml
    7485
    7586[processes/{id}]
     
    7990tags=ProcessDescription
    8091tags_description=
    81 schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/process.yaml
     92schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ProcessDescription.yaml
     93ecode=404
    8294parameters=/components/parameters/id
    8395
     
    95107tags=JobList
    96108tags_description=
    97 schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/jobCollection.yaml
     109schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/JobList.yaml
    98110parameters=/components/parameters/id
     111ecode=404,500
    99112method_1=post
    100113title_1=execute a job
     
    102115tags_1=Execute Endpoint
    103116tags_description_1=
    104 schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/result.yaml
    105 parameters_1=/components/parameters/id,/components/parameters/oas-header1
     117schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ExecuteSync.yaml
     118parameters_1=/components/parameters/id
     119ecode_1=400,404,500
     120eschema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ExecuteAsync.yaml
     121ep=,/components/parameters/oas-header1
    106122
    107123[requestBody]
     
    116132
    117133[processes/{id}/jobs/{jobID}]
     134length=2
    118135method=get
    119136title=The status of a job.
     
    121138tags=GetStatus
    122139tags_description=
    123 schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/statusInfo.yaml
     140schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/Status.yaml
    124141parameters=/components/parameters/id,/components/parameters/jobID
    125 
    126 [/processes/{id}/jobs/{jobID}/result]
     142method_1=delete
     143title_1=Cancel a job
     144abstract_1=Cancel the job execution.
     145tags_1=Dismiss
     146tags_description_1=Cencel a job execution
     147schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/Status.yaml
     148parameters_1=/components/parameters/id,/components/parameters/jobID
     149ecode_1=404,500
     150
     151
     152[/processes/{id}/jobs/{jobID}/results]
    127153rel=canonical
    128154type=application/json
    129155title=Get Result
    130156
    131 [processes/{id}/jobs/{jobID}/result]
     157[processes/{id}/jobs/{jobID}/results]
    132158method=get
    133159title=The result of a job execution.
     
    135161tags=GetResult
    136162tags_description=
    137 schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/result.yaml
     163schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/Results.yaml
    138164parameters=/components/parameters/id,/components/parameters/jobID
     165ecode=404,500
    139166ep=,/components/parameters/oas-header2
    140167
     
    151178tags_description=
    152179schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/valueType.yaml
    153 parameters=/components/parameters/id,/components/parameters/jobID,/components/parameters/resultID,/components/parameters/oas-header2
     180parameters=/components/parameters/id,/components/parameters/jobID,/components/parameters/resultID
     181ep=,/components/parameters/oas-header2
    154182
    155183
     
    184212required=false
    185213
    186 [conformTo]
    187 rootUrl=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/
     214[conformsTo]
     215rootUrl=http://www.opengis.net/spec/ogcapi-processes/1.0/conf/
     216rootUrl0=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/
    188217link=core
    189218link_1=oas30
    190219link_2=json
    191 length=3
     220link_3=job-list
     221link_4=dismiss
     222link_5=callback
     223length=6
    192224
    193225[exception]
    194226abstract=Exception
    195227type=application/json
    196 schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/exception.yaml
     228schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/NotFound.yaml
     229default_schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ServerError.yaml
     230
     231[responses]
     232length=5
     233code=404
     234schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/NotFound.yaml
     235type=application/json
     236title=NotFound
     237code_1=500
     238schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/ServerError.yaml
     239type_1=application/json
     240title_1=ServerError
     241code_2=400
     242schema_2=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/InvalidParameter.yaml
     243type_2=appliction/json
     244title_2=InvalidParameter
     245code_3=405
     246schema_3=https://github.com/opengeospatial/wps-rest-binding/blob/master/core/openapi/responses/NotAllowed.yaml
     247type_3=appliction/json
     248title_3=NotAllowed
     249code_4=406
     250schema_4=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/responses/NotSupported.yaml
     251type_4=appliction/json
     252title_4=NotSupported
     253
     254[callbacks]
     255length=3
     256state=jobSuccess
     257uri=successUri
     258schema=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/result.yaml
     259type=application/json
     260title=Results received successfully
     261state_1=jobInProgress
     262uri_1=inProgressUri
     263schema_1=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/statusInfo.yaml
     264type_1=application/json
     265title_1=Results received successfully
     266state_2=jobFailed
     267uri_2=failedUrii
     268schema_2=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas/exception.yaml
     269type_2=application/json
     270title_2=Exception received successfully
     271
     272[links_title]
     273self=View this document in JSON.
     274alternate=View the alternative version in HTML.
     275conformance=View the specifications that the link’s context conforms to.
     276service-desc=View the service description.
     277service-doc=View service documentation.
     278processes=View the list of processes the API offers.
     279results=View the results of a process.
     280status=View the current status of a job execution.
     281execute=View the execution endpoint of a process.
     282
     283[provider_alt]
     284addressDeliveryPoint=streetAddress
     285addressCity=addressLocality
     286addressAdministrativeArea=addressRegion
     287addressPostalCode=postalCode
     288addressCountry=addressCountry
     289addressElectronicMailAddress=email
     290phoneVoice=telephone
     291phoneFacsimile=faxNumber
     292hoursOfService=hoursAvailable
     293contactInstructions=contactOption
     294
Note: See TracChangeset for help on using the changeset viewer.

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