Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

identifier syntax for OAPI Common #19

Closed
pebau opened this issue May 3, 2019 · 9 comments
Closed

identifier syntax for OAPI Common #19

pebau opened this issue May 3, 2019 · 9 comments
Assignees

Comments

@pebau
Copy link
Contributor

pebau commented May 3, 2019

in several places we use identifiers (such as coverages, collections). We should define admissible names and their representation, such as: char set, encoding, entities for escaping special characters, etc.

@Schpidi
Copy link
Member

Schpidi commented May 3, 2019

Teleconference 20190503: Likely a topic for OGC API Common or even OpenAPI. Use international IRIs (RFC 3987). Comply to RFC 6570 "URI Template". There seems to be no coverage specific restrictions needed.

@cmheazel
Copy link
Contributor

The only real restriction I can think of is that path elements cannot include the ":" character. So qualified names cannot be used as commonly formatted :. Unless we want to specify how to work around this limitation, then I think @Schpidi suggestion to specify compliance with RFC 3987 and 5670 are the best option.

@hylkevds
Copy link

hylkevds commented Sep 6, 2019

For inspiration, OData (OGC SensorThings API) specifies for identifiers when used in URLs:

  • numbers are put in as-is
  • strings are quoted with single quotes (') and single quotes in the string are doubled (''), essentially as Ansi SQL. Any character is valid, including slashes, backslashes, colons. Certain characters have to be URL encoded (Percent-encoding) as per the URL specification to ensure the resulting URL is valid.

@ghobona
Copy link
Contributor

ghobona commented May 20, 2020

How about using the text below, taken from OGC API - Features" ?

"This document does not restrict the lexical space of URIs used in the API beyond the requirements of the HTTP and URI Syntax IETF RFCs. If URIs include reserved characters that are delimiters in the URI subcomponent, these have to be percent-encoded. See Clause 2 of RFC 3986 for details."

http://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_http_uris

@hylkevds
Copy link

percent-encoding of slashes in the path-part of a URL is problematic. Tomcat simply doesn't allow it, many other systems have problems with it too. Essentially, the Features text ends up being "slashes are not allowed in identifiers", so it would be better to explicitly state that...

@Schpidi
Copy link
Member

Schpidi commented May 20, 2020

In the_ WCS SWG teleconference it was decided to recommend using hyphens to encode colons as used in qualified names to OGC NA and ask for feedback.

@ghobona
Copy link
Contributor

ghobona commented Jun 12, 2020

Please note this comment opengeospatial/NamingAuthority#55 (comment)

@Schpidi
Copy link
Member

Schpidi commented Jul 8, 2020

20200708: As stated in opengeospatial/NamingAuthority#55 this would be out of scope of OGC-NA and best addressed by OGC API standards themselves which would probably make it an OGC API - Common issue.

@cmheazel
Copy link
Contributor

cmheazel commented Jul 8, 2020

This issue has been re-assigned to API-Common Issue 153.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

5 participants