Skip to content
Collection+JSON Extensions
Find file
Latest commit a20cb7c @mamund mamund Merge pull request #16 from glanotte/master
add an extension for a deprecated property
Failed to load latest commit information.
README.md updated to include process info
command-templates.md Update command-templates.md
deprecate.md add an extension for a deprecated property
errors.md
inline.md Move from original repo
link-with-image.md addition of link-with-image extension to the collection+json repo
model.md Move from original repo
read-only.md Minor edits to the read-only extension
template-validation.md Move from original repo
templates.md Move from original repo
uri-templates.md Move from original repo
validation_array.md clarify language around required information
value-types.md Fix Type in Sample Json (was invalid)

README.md

extensions

Collection+JSON Extensions

This repo contains rough working documents on suggested extensions to the Collection+JSON format. To be included here, an extension MUST NOT introduce any breaking changes to the existing spec. IOW, adding the extension to a response MUST NOT cause any existing (compliant) implementation to break.

Guidelines

Generally, the guidelines for creating extentions are:

  • Don't Take Away Stuff : You MUST NOT remove any existing element that is already defined in the Cj documentation.
  • Don't Redefined Stuff : You MUST NOT change the meaning or processing rules for any existing element.
  • All New Stuff is Optional : Any new element MUST be OPTIONAL. You MUST NOT create a new REQUIRED element in a Cj representation.

Process

Adding an extension here is really easy. Here's the typical process:

  • Post to the Cj List : Send a note to the list suggestion an extension (or outlining the one you already created)
  • Work up an Example : Write up a simple example w/ text that describes the extension, what it is used for, etc. Be sure to reference the discussion thread in the forum to help people coming later to find the background
  • Do a PR to the Repo : Execute a Pull Request against the extensions repo (that includes your example MD file). This will kick off the final discussion and result in an addition to the repo.

If you have any Qs, suggestions, etc. on how to make this process better, feel free to post to the Cj forum.

Something went wrong with that request. Please try again.