opengeospatial / ogcapi-common

OGC API - Common provides those elements shared by most or all of the OGC API standards to ensure consistency across the family.
https://ogcapi.ogc.org/common
Other
45 stars 14 forks source link

Agreement as to the name of Part 2 resources (e.g. Table 2) #232

Open jerstlouis opened 3 years ago

jerstlouis commented 3 years ago

Part 2 defines two main resources:

We need to agree on how to name these resources.

Additionally, /items is also included in Table 2.

The names currently used are wrong (Metadata for /collections, Description for /collections/{collectionId}, Collection for /collections/{collectionId}/items).

cmheazel commented 3 years ago

@jerstlouis I thought we finished with this in #105

jerstlouis commented 3 years ago

@cmheazel I believe you asked me to file this issue at the 21-05-07 SWG meeting because we agreed it still needed some work.

Looking at the Table 2 in the latest generated draft:

I see that /items is gone from this table (I think that's a good thing). However I see a few left overs that probably needs to be fixed:

cmheazel commented 3 years ago

@jerstlouis Sorry, my mistake.
Carry on.

cportele commented 3 years ago

@jerstlouis

I am happy with /collections/{collectionId} being called Collection Description. Is that OK with Features @cportele though? It could also be called the Collection itself, with the clarification that you do get a description of it when you ask for e.g. a JSON representation (and not its content)

In Features the resource is called "Feature Collection" (http://docs.opengeospatial.org/DRAFTS/17-069r4.html#tldr) as a subtype of the more general "Collection" (http://docs.opengeospatial.org/DRAFTS/17-069r4.html#core-overview) that is not limited to items that are features.

It was Collection Metadata earlier in the draft phase of Features, but that was changed, because it did not work. The discussion is in opengeospatial/ogcapi-features#217. It would be good, if Common does not change the terminology or allows other specs to keep using their resource names.

cmheazel commented 3 years ago

June 15 2021 - return to the API Features convention of Collections and Collection. Make sure the terms are sufficiently well defined that they avoid confusion.

NOTUC

cmheazel commented 3 years ago

June 15 recommendation has been implemented except for the ATS.
Update of the ATS is covered by issue #178

cmheazel commented 3 years ago

June 26 2021 - Change resource collection to collection resource Change title of table 2 to Resources. Change "Description" column header on Table 2 to "Response"