URL for errata

Issue #978 open
Nat Sakimura created an issue

We should get new URIs for erratas instead of over-writing the previous ones. e.g., http://openid.net/specs/openid-connect-core-1_0e1.html instead of http://openid.net/specs/openid-connect-core-1_0.html.

http://openid.net/specs/openid-connect-core-1_0.html then should be marked as "has errata" which links to the errata incorporated version.

Comments (6)

  1. Nat Sakimura reporter
    • changed status to open

    WG call on Aug 17 agreed that since other specs may be referencing it, it is better not to over-write the content of a URI unless it is purely editorial.

  2. Michael Jones

    We already use separate URLs for each final and errata spec version and they are never overwritten. For instance, for Core, these URLs are, respectively, http://openid.net/specs/openid-connect-core-1_0-final.html and http://openid.net/specs/openid-connect-core-1_0-errata1.html.

    We also have a URL for the current version, in this case, http://openid.net/specs/openid-connect-core-1_0.html. It currently contains a copy of -errata1.

    The new errata, once approved, will be released at http://openid.net/specs/openid-connect-core-1_0-errata2.html and http://openid.net/specs/openid-connect-core-1_0.html. References should continue to use the current version URL.

  3. Michael Jones

    We should probably make a blog post saying how other specs can reference current versions and specific versions, as makes sense in their use cases.

  4. Nat Sakimura reporter

    There should be [errata exists] and [errata incorporated on] on the each side so that the readers can refer to each other.

  5. Michael Jones

    I strongly believe that we must not edit existing approved specifications in any way. That's an important part of our contract as a standards organization to users of the standards. In particular, this precludes editing "Final OpenID Connect Core 1.0" and "Final OpenID Connect Core 1.0 incorporating errata set 1" to add anything.

    I'm fine adding links to these previous versions when we create "Final OpenID Connect Core 1.0 incorporating errata set 2" to help people locate the previous versions, should they want to do so - and likewise for the other specs we're creating new errata versions for.

  6. Michael Jones

    As discussed during the 17-Jun-21 call, we already indicating the presence of errata by including “incorporating errata set N” in the titles of updated documents. We do update the unversioned URLs, which point to the most current approved drafts, such as https://openid.net/specs/openid-connect-core-1_0.html. Since the unversioned URLs are the ones actually referenced, including by search engines, we are already accomplishing the goal of this issue. I therefore propose that we close this issue on that basis.

  7. Log in to comment