w3c / sdw

Repository for the Spatial Data on the Web Working Group
https://www.w3.org/2020/sdw/
149 stars 81 forks source link

Reduce ambiguity #1332

Closed PeterParslow closed 2 years ago

PeterParslow commented 2 years ago

The list is quite a long way above (with several bullet points between), so including the phrase "Bespoke API" helps.

"as" is ambiguous (I initially read it as about to introduce the name/description of the third option); "because" is less so.

PeterParslow commented 2 years ago

I hope someone is re-writing much of this section to include description of the more contemporary OGC APIs

PeterParslow commented 2 years ago

And what's the relationship between "Bespoke APIs" and "Convenience APIs"?

chris-little commented 2 years ago

And what's the relationship between "Bespoke APIs" and "Convenience APIs"?

@PeterParslow Complexity vs Simplicity?

cportele commented 2 years ago

And what's the relationship between "Bespoke APIs" and "Convenience APIs"?

A "bespoke API" is an API that largely ignores standardized API building blocks (using OGC API terminology).

A "convenience API" is an API that is designed for a specific usage (convenient for clients supporting that use case).

There is no strict relationship. Sometimes an API has to be "bespoke" to be "convenient", but for other uses an OGC Web API (not "bespoke") can also be "convenient". BP 12 basically says that you should look at the user needs in your API design.

When we wrote BP 12 five years ago the point was that WFS etc are for most web uses/users not easy or convenient to use. In that sense the text implies that often convenience implies bespoke, but there has been some progress and the whole discussion needs a review.