Skip to content

Organization of rest design workgroup

Peter Van den Bosch edited this page Aug 31, 2020 · 4 revisions
  • all issues under discussion are managed as GitHub issues
    • elaboration and discussion can take place in issue mgmt system
    • after triaging, issues are assigned to "in progress" or "backlog" milestone
    • assigned to person which leads the issue (preferably with experience on the issue)
  • meeting +/- each two months
    • new issues are presented, issues in progress are reviewed
    • issues with highest priority are selected to be prepared before next meeting
    • decision on these issues takes place on the next meeting

Scope of the workgroup:

  • API
  • Uniform interface
  • HTTP methods
  • Resources
  • Collection
  • Document
  • Controller
  • JSON Schema en OpenAPI
  • Versioning
  • Caching
  • Hypermedia controls
  • error handling, http status codes
  • representation of most common business data (based on and validated by functional work group)

Out of scope:

  • security (security work group)
  • semantics and naming of specific business vocabularies (functional work group)