the-fair-cookbook icon indicating copy to clipboard operation
the-fair-cookbook copied to clipboard

Issue on page /content/recipes/findability/identifiers.html

Open saubin78 opened this issue 3 years ago • 3 comments

Hi! Section 1.7. Generating Resolvable URLs states that "it is necessary for the resource identifiers to comply to the RFC 3986 IETF standard for URIs" then that "1. scheme: https". Yet, I can see nowhere in the RFC 3986 IETF standard the mention of secure http, i.e. https. Is it an error or do you have reasons to recommend https ? (which imho seems odd in an open data world and can be handled at the server level)

Best and thanks for the cookbook :-)

saubin78 avatar May 28 '21 13:05 saubin78

Hi @saubin78 , thanks for pointing this out!

You are right, https is not a "must" as stated in the sentence above.

We have two options now: 1) you could change the text / passage yourself, and create a pull request here (if you are familiar with that workflow) or

  1. we could do it, but I fear that it will take some time until this bug is actually picked up.

Do you have any preference? Best, Robert

robertgiessmann avatar Jun 09 '21 10:06 robertgiessmann

I'll remove my assignment here as I go on parental leave for the rest of the year

robertgiessmann avatar Mar 04 '22 16:03 robertgiessmann

@saubin78

I believe his can be fixed by rewording the example. The "must" referred to each of the components rather than the values supplied as examples.

So the fix would look like this:

  1. scheme: e.g. https
  2. an authority: e.g. www.example.com
  3. optionally a path: e.g. /dataset-name/
  4. a local identifier: e.g. P1223 (such as database accession number from uniprot) or a globally unique identifier (such as a UUID or hash code).

Let me know if this addresses your concern. Thank you again for pointing out the issue

proccaserra avatar Jul 27 '22 22:07 proccaserra