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

Include recommendation for escaping @id values #169

Open
balmas opened this issue Oct 21, 2019 · 2 comments
Open

Include recommendation for escaping @id values #169

balmas opened this issue Oct 21, 2019 · 2 comments
Labels
Documentation Issues related to documentation typos, design, etc.

Comments

@balmas
Copy link
Contributor

balmas commented Oct 21, 2019

@balmas

... in this implementation sometimes properties use html-escaped versions of ids and paths and sometimes they don't.

@zflecth

I think my implementation uses escaped IDs when they're part of a path and unescaped IDs when they're just a normal string. So, urn:cts:greekLit:tlg0012.tlg001.perseus-grc2 is not escaped in the collections endpoint but it is escaped in the navigation endpoint because the ID is /navigation?.... I can't think of a better way of doing this, it seems wrong to escape a regular string and not escaping a path could cause problems.

Originally posted by @zfletch in #163 (comment)

@PonteIneptique PonteIneptique added the Documentation Issues related to documentation typos, design, etc. label Oct 25, 2019
@hcayless
Copy link
Contributor

hcayless commented Feb 7, 2024

Recommend following RFC 3986 for identifier syntax in the documentation.

@jonathanrobie
Copy link
Contributor

We may want to consider the following guidelines:

https://datatracker.ietf.org/doc/html/draft-ietf-iri-comparison-01

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to documentation typos, design, etc.
Projects
Status: Accepted
Development

No branches or pull requests

4 participants