solid / solid/specification

Document changelog from "roughly-0.8" to "Dec-2019"

Open
#135 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc: Protocol status: Waiting for Commenter
Dominant language
HTML
Stars
563
Forks
108
Avg merge
4d 13h
Merged PRs (30d)
3

Description

Please document the changelog from the roughly-0.8 version to the Dec-2019 version. It may be useful to categorize the changes by if and how they require action from server- and/or client- implementers:

  • changes that will make a roughly-0.8 server incompatible with a Dec-2019 client
  • changes that will make a roughly-0.8 client incompatible with a Dec-2019 server
    1. #77 Restructure JWT in Authorization header Bearer token (the SolidAuthClient will look at the WWW-Authenticate header and be able to switch between both formats, but new servers will only be required to implement the new one). Note that this change will at first be documented in a PR and not in the master spec text, but @jaxoncreed will already add support for it to Solid-Auth-Client.
    2. Add AUTH command to WebSockets protocol (older servers will ignore the AUTH command but newer ones will require it)
    3. Remove SPARQL-on-GET
    4. Remove Globbing
  • changes that will break compatibility in both directions
  • changes that are non-breaking

@csarven @kjetilk is this list correct?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the specification changes between the roughly-0.8 and Dec-2019 versions, starting with issue #77 and the listed JWT, WebSockets AUTH, SPARQL-on-GET, and Globbing changes. Done means a changelog categorizes changes as server-breaking, client-breaking, breaking in both directions, or non-breaking, with the compatibility implications documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.