opengeospatial / ogcapi-processes

https://ogcapi.ogc.org/processes
Other
48 stars 45 forks source link

Clarify what is expected for callback request/response #366

Open fmigneault opened 1 year ago

fmigneault commented 1 year ago

The clause https://github.com/opengeospatial/ogcapi-processes/blob/8c41db3fbc804450c89d94b704e1d241105272ae/core/sections/clause_13_callback.adoc properly indicates what needs to be done for successUri, but does not provide any details regarding inProgressUri and failedUri from https://github.com/opengeospatial/ogcapi-processes/blob/8c41db3fbc804450c89d94b704e1d241105272ae/openapi/schemas/processes-core/subscriber.yaml.

The callbacks for these other URIs are also missing in https://github.com/opengeospatial/ogcapi-processes/blob/8c41db3fbc804450c89d94b704e1d241105272ae/core/examples/yaml/callbacks.yaml

pvretano commented 6 months ago

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.

fmigneault commented 6 months ago

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: https://github.com/opengeospatial/ogcapi-processes/blob/d011fe92750a0843106fcb87b6292db6e2b0fa51/core/examples/yaml/callbacks.yaml#L2-L9 Since it only shows successUri, users have to stumble upon the schema to learn about inProgressUri and failedUri.

bpross-52n commented 3 months ago

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