opengeospatial / ogcapi-processes

Home Page:https://ogcapi.ogc.org/processes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Clarify what is expected for callback request/response

fmigneault opened this issue · comments

I can see that inProcessUri and failedUri are in now in subscriber.yaml but when I read the callback clause I see no discussion about any of these URIs. Rather there is a reference to OpenAPI docs. Is this sufficient? If not, someone with more knowledge about API callback then me will have to take this one.

A link to https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/subscriber.yaml would be sufficient.
At the moment, only a link to the following example is provided:

jobCompleted:
'{$request.body#/subscriber/successUri}':
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/results'

Since it only shows successUri, users have to stumble upon the schema to learn about inProgressUri and failedUri.

SWG meeting from 2024-08-05: @pvretano will implement @fmigneault's suggestion.