Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

  • REST
  • Json-based.  XML, YAML-support optional (determined by server).  Format determined by url parameter
  • Wiki MarkupGeneric url structure: {{\[http://api.example.com/version/resources\{/id\}}}
  • Four possible http return codes: 200 (ok), 401 (not authorized),  400 (generic client-side error), 500 (generic server-side error)
  • Paginate by url parameters limit and offset (0-based).  Default: limit=10, offset=0
  • Returned object structure: always 2 members: meta and data
  • meta always contains: numoffsettotal
  • data is always an array, even if it contains only a single object
  • Authorisation handled by OAuth2 (if required)
    • TODO: onderscheid tussen app-based authZ (voor telefoonboek etc), en personal data (authN required)
  • All strings: unlimited size, UTF8, unless otherwise specified
  • All integers: 32 bit signed, unless otherwise specified.  null==unknown
  • Follow URL-style json-api as much as practical (http://jsonapi.org/format/#url-based-json-api)

...