Ignore:
Timestamp:
Mar 9, 2021, 4:50:02 PM (3 years ago)
Author:
djay
Message:

Move the execute endpoint to /processes/{processID}. Fixes in oas.cfg: use opengeospatial/ogcapi-processes github repo for schemas URLs.

File:
1 edited

Legend:

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

    r967 r986  
    11[openapi]
    22use_content=false
    3 rootUrl=https://myserver/ogc-api
    4 links=/,/api,/conformance,/processes
    5 paths=/root,/api,/conformance,/processes,/processes/{id},/processes/{id}/jobs,/processes/{id}/jobs/{jobID},/processes/{id}/jobs/{jobID}/results
    6 parameters=id,jobID,resultID
     3rootUrl=http://localhost/ogc-api
     4links=/,/api,/conformance,/processes,/jobs
     5paths=/root,/api,/conformance,/processes,/processes/{processID},/jobs,/jobs/{jobID},/jobs/{jobID}/results
     6parameters=processID,jobID,resultID
    77version=3.0.2
    88license_name=OGC license
    9 license_url=https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/LICENSE
    10 full_html_support=false
     9license_url=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/LICENSE
     10full_html_support=true
    1111partial_html_support=true
    12 wsUrl=wss://demo.mapmint.com:4430/
    13 publisherUrl=http://127.0.0.1/cgi-bin3/publish.py?jobid=
    14 io_as_array=true
     12wsUrl=ws://localhost:8888/
     13publisherUrl=http://localhost/cgi-bin/publish.py?jobid=
    1514
    1615[/]
     
    2524tags=Home
    2625tags_description=
    27 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/LandingPage.yaml
     26schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/LandingPage.yaml
    2827
    2928[/index.html]
     
    4140
    4241[api.html]
    43 href=https://demo.mapmint.com/swagger-ui/ogc-api-processes/
     42href=http://localhost/swagger-ui/oapip/
    4443
    4544[api]
     
    6261tags=Conformance
    6362tags_description=
    64 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/ConformanceDeclaration.yaml
     63schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ConformanceDeclaration.yaml
    6564
    6665[/conformance.html]
     
    7978tags=GetCapabilities
    8079tags_description=
    81 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/ProcessList.yaml
     80schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ProcessList.yaml
    8281
    8382[/processes.html]
     
    8584type=text/hml
    8685
    87 [processes/{id}]
     86[processes/{processID}]
     87length=2
    8888method=get
    8989title=retrieve a process description
     
    9191tags=ProcessDescription
    9292tags_description=
    93 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/ProcessDescription.yaml
     93schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ProcessDescription.yaml
    9494ecode=404
    95 parameters=/components/parameters/id
    96 
    97 
    98 [/processes/{id}/jobs]
    99 rel=canonical
    100 type=application/json
    101 title=Process Description
    102 
    103 [processes/{id}/jobs]
    104 length=2
    105 method=get
    106 title=retrieve a list of jobs run
    107 abstract=A list of jobs run.
    108 tags=JobList
    109 tags_description=
    110 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/JobList.yaml
    111 parameters=/components/parameters/id
    112 ecode=404,500
     95parameters=/components/parameters/processID
    11396method_1=post
    11497title_1=execute a job
     
    11699tags_1=Execute Endpoint
    117100tags_description_1=
    118 schema_1=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/ExecuteSync.yaml
    119 parameters_1=/components/parameters/id
     101schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteSync.yaml
     102parameters_1=/components/parameters/processID
    120103ecode_1=400,404,500
    121 eschema_1=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/ExecuteAsync.yaml
     104eschema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteAsync.yaml
     105
     106[/jobs]
     107rel=canonical
     108type=application/json
     109title=Job Management
     110
     111[jobs]
     112length=1
     113method=get
     114title=retrieve a list of jobs run
     115abstract=A list of jobs run.
     116tags=JobList
     117tags_description=
     118schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/JobList.yaml
     119parameters=
     120ecode=404,500
     121method_1=post
     122title_1=execute a job
     123abstract_1=An execute endpoint.
     124tags_1=ExecuteEndpoint
     125tags_description_1=
     126schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteSync.yaml
     127parameters_1=
     128ecode_1=400,404,500
     129eschema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ExecuteAsync.yaml
    122130ep=,/components/parameters/oas-header1
    123131
     
    125133abstract=Mandatory execute request in JSON format
    126134type=application/json
    127 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/schemas/execute.yaml
    128 
    129 [/processes/{id}/jobs/{jobID}]
     135schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/execute.yaml
     136
     137[/jobs.html]
     138rel=alternate
     139type=text/hml
     140
     141[/jobs/{jobID}]
    130142rel=canonical
    131143type=application/json
    132144title=Status
    133145
    134 [processes/{id}/jobs/{jobID}]
     146[jobs/{jobID}]
    135147length=2
    136148method=get
     
    139151tags=GetStatus
    140152tags_description=
    141 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/Status.yaml
    142 parameters=/components/parameters/id,/components/parameters/jobID
     153schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml
     154parameters=/components/parameters/jobID
    143155method_1=delete
    144156title_1=Cancel a job
    145157abstract_1=Cancel the job execution.
    146158tags_1=Dismiss
    147 tags_description_1=Cencel a job execution
    148 schema_1=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/Status.yaml
    149 parameters_1=/components/parameters/id,/components/parameters/jobID
     159tags_description_1=Cancel a job execution
     160schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Status.yaml
     161parameters_1=/components/parameters/jobID
    150162ecode_1=404,500
    151163
    152 
    153 [/processes/{id}/jobs/{jobID}/results]
     164[/jobs/{jobID}/results]
    154165rel=canonical
    155166type=application/json
    156167title=Get Result
    157168
    158 [processes/{id}/jobs/{jobID}/results]
     169[jobs/{jobID}/results]
    159170method=get
    160171title=The result of a job execution.
     
    162173tags=GetResult
    163174tags_description=
    164 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/Results.yaml
    165 parameters=/components/parameters/id,/components/parameters/jobID
     175schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/Results.yaml
     176parameters=/components/parameters/jobID
    166177ecode=404,500
    167178ep=,/components/parameters/oas-header2
    168179
    169 [/processes/{id}/jobs/{jobID}/result/{resultID}]
    170 rel=canonical
    171 type=application/json
    172 title=Get Result
    173 
    174 [processes/{id}/jobs/{jobID}/result/{resultID}]
    175 method=get
    176 title=The result of a job execution.
    177 abstract=The result of a job execution.
    178 tags=GetResult
    179 tags_description=
    180 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/schemas/valueType.yaml
    181 parameters=/components/parameters/id,/components/parameters/jobID,/components/parameters/resultID
    182 ep=,/components/parameters/oas-header2
    183 
    184 
    185 [{id}]
     180[{processID}]
    186181type=string
    187182title=The id of a process
     
    214209
    215210[conformsTo]
    216 rootUrl=http://www.opengis.net/spec/ogcapi-processes/1.0/conf/
     211rootUrl=http://www.opengis.net/spec/ogcapi-processes/1.0/req/
    217212rootUrl0=http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/
    218213link=core
     
    222217link_4=dismiss
    223218link_5=callback
    224 length=6
     219link_6=ogc-process-description
     220link_7=html
     221length=8
    225222
    226223[exception]
    227224abstract=Exception
    228225type=application/json
    229 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/NotFound.yaml
    230 default_schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/ServerError.yaml
     226schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/responses/NotFound.yaml
     227default_schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml
    231228
    232229[responses]
    233230length=5
    234231code=404
    235 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/NotFound.yaml
     232schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotFound.yaml
    236233type=application/json
    237234title=NotFound
    238235code_1=500
    239 schema_1=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/ServerError.yaml
     236schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml
    240237type_1=application/json
    241238title_1=ServerError
    242239code_2=400
    243 schema_2=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/InvalidParameter.yaml
     240schema_2=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/InvalidParameter.yaml
    244241type_2=appliction/json
    245242title_2=InvalidParameter
    246243code_3=405
    247 schema_3=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/NotAllowed.yaml
     244schema_3=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotAllowed.yaml
    248245type_3=appliction/json
    249246title_3=NotAllowed
    250247code_4=406
    251 schema_4=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/responses/NotSupported.yaml
     248schema_4=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotSupported.yaml
    252249type_4=appliction/json
    253250title_4=NotSupported
     
    257254state=jobSuccess
    258255uri=successUri
    259 schema=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/schemas/result.yaml
     256schema=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/result.yaml
    260257type=application/json
    261258title=Results received successfully
    262259state_1=jobInProgress
    263260uri_1=inProgressUri
    264 schema_1=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/schemas/statusInfo.yaml
     261schema_1=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/statusInfo.yaml
    265262type_1=application/json
    266 title_1=Results received successfully
     263title_1=Status received successfully
    267264state_2=jobFailed
    268 uri_2=failedUrii
    269 schema_2=https://raw.githubusercontent.com/gfenoy/wps-rest-binding/change-request/95/core/openapi/schemas/exception.yaml
     265uri_2=failedUri
     266schema_2=https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/exception.yaml
    270267type_2=application/json
    271268title_2=Exception received successfully
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