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

Introduce Profiles to v1.1 #1268

Merged
merged 30 commits into from Sep 18, 2018
Merged

Introduce Profiles to v1.1 #1268

merged 30 commits into from Sep 18, 2018

Commits on Apr 15, 2018

  1. Introduce Profiles to v1.1

    Profiles are a means to describe additional semantics the JSON API media type, without altering the basic semantics.
    
    Profiles are identified by URI, which ideally should dereference to a document that describes the semantics of the profile.
    
    One or more profiles may be associated with the JSON API media type through the `profile` media type parameter. The application of profiles to a particular document can be specified by clients and servers  via the `Content-Type` header. The application of one or more profiles to a response can be requested by a client via the `Accept` header.
    
    In order to require the application of one or more profiles, the profile(s) must be specified with the `profile` query parameter.
    
    Any structural elements introduced by a profile can be aliased. This allows for better adaptability and composition of profiles. A new profile descriptor object is introduced which allows for declarations of aliases in a particular document.
    
    Closes #1207
    dgeb committed Apr 15, 2018
    Copy the full SHA
    9c0b91b View commit details
    Browse the repository at this point in the history

Commits on Apr 17, 2018

  1. profiles: tweak definitions a bit

    E.g., clarify that profiles can cover any implementation-specific query
    params, not just sort/filter/page
    ethanresnick committed Apr 17, 2018
    Copy the full SHA
    3f4220f View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    7533232 View commit details
    Browse the repository at this point in the history
  3. Copy the full SHA
    8b51551 View commit details
    Browse the repository at this point in the history
  4. Copy the full SHA
    fe660ec View commit details
    Browse the repository at this point in the history
  5. Copy the full SHA
    510e783 View commit details
    Browse the repository at this point in the history
  6. profiles: clarify that Accept may be totally ignored

    This is key for servers that don’t want to add `Vary: Accept` for
    better caching
    ethanresnick committed Apr 17, 2018
    Copy the full SHA
    36f4c0a View commit details
    Browse the repository at this point in the history
  7. Copy the full SHA
    4085f31 View commit details
    Browse the repository at this point in the history
  8. profiles: clarify that keywords must be valid member names

    Should be obvious, but worth saying
    ethanresnick committed Apr 17, 2018
    Copy the full SHA
    e08d3ce View commit details
    Browse the repository at this point in the history
  9. profiles: clarify evolution requriments

    The link to the w3c tag terminology about backwards and forwards
    compatibility is more precise than “evolve additively”, though it
    doesn’t change the intended meaning
    ethanresnick committed Apr 17, 2018
    Copy the full SHA
    67ff7f1 View commit details
    Browse the repository at this point in the history
  10. Copy the full SHA
    51d0be6 View commit details
    Browse the repository at this point in the history

Commits on Apr 30, 2018

  1. Copy the full SHA
    1827986 View commit details
    Browse the repository at this point in the history

Commits on Jul 1, 2018

  1. Copy the full SHA
    eb2e815 View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    e0397c2 View commit details
    Browse the repository at this point in the history

Commits on Jul 13, 2018

  1. Copy the full SHA
    7221b18 View commit details
    Browse the repository at this point in the history
  2. Replace all usages of jsonapi/profiles with links/profile

    Also add examples of profiles
    dgeb committed Jul 13, 2018
    Copy the full SHA
    18b590e View commit details
    Browse the repository at this point in the history

Commits on Jul 22, 2018

  1. Copy the full SHA
    661ddbc View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    e1232a9 View commit details
    Browse the repository at this point in the history

Commits on Jul 27, 2018

  1. Copy the full SHA
    1e448f8 View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    9be7013 View commit details
    Browse the repository at this point in the history
  3. profiles: add must-ignore rule to example timestamps profile

    Technically, this rule is required to make it legal to add even a new,
    optional member to the timestamps object.
    ethanresnick committed Jul 27, 2018
    Copy the full SHA
    7757134 View commit details
    Browse the repository at this point in the history
  4. profiles: create separate authoring section

    This commit just pulls the existing guidelines about authoring profiles
    into a dedicated section, without changing any of the substance.
    
    I’m pulling this out because there are a few requirements for authoring
    profiles that I think are missing, and it was getting a bit messy to
    have the rules for authoring profiles all mixed in with the rules for
    using them.
    ethanresnick committed Jul 27, 2018
    Copy the full SHA
    055a41f View commit details
    Browse the repository at this point in the history
  5. Copy the full SHA
    3599821 View commit details
    Browse the repository at this point in the history

Commits on Aug 28, 2018

  1. Copy the full SHA
    7f9eb81 View commit details
    Browse the repository at this point in the history

Commits on Aug 29, 2018

  1. Copy the full SHA
    e151c57 View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    e666c90 View commit details
    Browse the repository at this point in the history

Commits on Sep 18, 2018

  1. 1
    Copy the full SHA
    db1e970 View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    61ccdff View commit details
    Browse the repository at this point in the history
  3. profiles: small cleanup

    ethanresnick committed Sep 18, 2018
    Copy the full SHA
    ebae1b5 View commit details
    Browse the repository at this point in the history
  4. Copy the full SHA
    f8770df View commit details
    Browse the repository at this point in the history