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

site-wide location configuration for metadata files #605

Merged
merged 20 commits into from Jun 30, 2015

Conversation

JeniT
Copy link

@JeniT JeniT commented Jun 10, 2015

fixes #555

I took a look and decided to make this as simple, and specific to CSV on the Web, as possible, to avoid delays. So the definition is just a file of URI templates.

@mnot I'd appreciate your review.

@6a6d74
Copy link
Contributor

6a6d74 commented Jun 10, 2015

@JeniT - having read through the new section on site-wide metadata location, it all makes sense. Including the example provides extra clarity. +1 from me for merge.

@iherman
Copy link
Member

iherman commented Jun 10, 2015

I only have an editorial (a.k.a. bike-shedding) issue: is the variable name base the good one? Seeing, say, http://example.org/south-west/devon.csv, my reaction would be that the base is http://example.org/south-west/, rather then the whole URI. We could use the variable url (though I realize this is not ideal, because the fragment is dropped from the original URL).

But that is bike-shedding, I am o.k. with the text otherwise.

@JeniT
Copy link
Author

JeniT commented Jun 10, 2015

I'm happy to use another name for the variable. Ones I thought of were url, href, file, csv, location, table.

@iherman
Copy link
Member

iherman commented Jun 10, 2015

I'm happy to use another name for the variable. Ones I thought of were url, href, file, csv, location, table.

'location' is probably most neutral…

@gkellogg
Copy link
Member

Haven't heard back form @mnot on this. It would be nice to have consensus to commit the PR and close the issue.

@mnot
Copy link
Member

mnot commented Jun 17, 2015

Looks good. You might want to be a bit tighter on what "not found" means - think you mean HTTP 404 or 410. However, you should also consider:

  • redirects (temp and perm)
  • timeouts, network not available
  • transient 5xx errors
  • etc.

You may not need to go that that level of detail, just worth thinking about.

@JeniT
Copy link
Author

JeniT commented Jun 17, 2015

@mnot do you have any suggested wording? My first reaction to your comment was to try to refer to https://fetch.spec.whatwg.org/ but I think we will have problems referring to that in a normative way.

@gkellogg
Copy link
Member

Perhaps the paragraph could simply be the following:

In this case, processors MUST retrieve the file from the well-known URI /.well-known/csvm. (Well-known URIs are defined by [RFC5785].) If no such file is located (i.e., response to HTTP request is 4xx), processors MUST proceed as if this file were found with the content:

Alternatively, somewhat more normative:

In this case, processors MUST retrieve the file from the well-known URI /.well-known/csvm. (Well-known URIs are defined by [RFC5785].) If the response is HTTP status 404 Not Found, or any other status 4xx, processors MUST proceed as if this file were found with the content:

Status 5xx may be transient, and convey no useful information to affect processor behavior other than to fail with an error.

@iherman
Copy link
Member

iherman commented Jun 19, 2015

I may miss something, but... I was looking at the section with the example. The text says that

{+url}.json
csvm.json
/csvm?file={url}

may lead to http://example.org/south-west/csvm.json. Is that correct? Why would the second line expand in the base directory of the original CSV file's URI? Isn't it correct that we may need a second variable, base and that the second line in the example above should be

{base}/csvm.json

Note that this also affects the default value for the file.

@gkellogg
Copy link
Member

The steps defined in Site-wide Location Configuration say to expand the template using url and then resolve the URL against the tabular data file.

Note that expanding a URI Template does not create an absolute URL necessarily, so it does need to be resolved against something. We specify how this is to be done explicitly.

@iherman
Copy link
Member

iherman commented Jun 19, 2015

Ah.

"Resolve the resulting URL against the URL of the requested tabular data file."

Indeed. I missed that; sorry for the noise!

…own-location

# Conflicts:
#	tests/index.html
#	tests/manifest-json.jsonld
#	tests/manifest-json.ttl
#	tests/manifest-rdf.jsonld
#	tests/manifest-rdf.ttl
#	tests/manifest-validation.jsonld
#	tests/manifest-validation.ttl
#	tests/manifest.csv
@gkellogg
Copy link
Member

Both the cachability of .well-known/csvm and the at-risk text can probably use some word-smithing.

@JeniT
Copy link
Author

JeniT commented Jun 30, 2015

I have incorporated wordsmithing from this thread.

@gkellogg could you check the manifest.csv against the one in gh-pages? There were merge issues, but I couldn't locate the differences to fix them. When you're happy please merge.

gkellogg added a commit that referenced this pull request Jun 30, 2015
site-wide location configuration for metadata files
@gkellogg gkellogg merged commit 3293bac into gh-pages Jun 30, 2015
@gkellogg gkellogg deleted the issue-555-well-known-location branch June 30, 2015 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Non-standard well-known location processing
5 participants