Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 1.02 KB

README.rest

File metadata and controls

30 lines (26 loc) · 1.02 KB

SUSE Studio APIv3 design documents

  • Overview discusses design guidelines for SUSE Studio APIv3.
  • REST describes the architectural style in the context of HTTP.
  • HTTP Status Codes discusses semantics of HTTP status codes and their use in SUSE Studio APIv3.
  • Resources describes exposed resources and semantics of their manipulation.
  • schema/ contains proposed JSON Schema v04 descriptions, using CoffeeScript syntax.
  • Server documents currently preferred tooling for the server-side implementation.
  • Feedback sums up the discussions I've had with APIv2 users about its shortcomings and APIv3 directions.

Everything here is very much WIP.