Skip to content

v3.0.0

Latest
Compare
Choose a tag to compare
@bglamadrid bglamadrid released this 16 Aug 03:51

Since v1.7.3

Added

  • Generic error response and response body schema, named Error and AppError respectively

Changed

  • [BREAKING CHANGE] All error responses were replaced in favor of the new generic error schema
  • [BREAKING CHANGE] In newly-named Order, Customer and Salesperson now reference a Person element instead
  • [BREAKING CHANGE] Rename all instances of Sell to Order
    • Tag sales -> orders
    • Endpoint /data/sales -> /data/orders
      • All methods GET, POST, PUT and PATCH
      • All subroutes
        • /confirmation
        • /rejection
        • /completion
    • Schemas
      • Sell -> Order
      • SellProperties -> OrderProperties
      • SellDetail -> OrderDetail
      • SellDetailProperties -> OrderDetailProperties
    • All uses of the noun in literal descriptions
  • [BREAKING CHANGE] Standard status codes in replacement of vague 200
    • All /data/ POST endpoints will return 201
      • Excepting the three subroutes within /data/orders which will return 204:
        • /confirmation
        • /rejection
        • /completion
    • All /data/ PUT, PATCH, DELETE and OPTIONS endpoints will return 204

Removed

  • [BREAKING CHANGE] Error response schemas
    • Forbidden
    • NotFound
    • BadRequestBody
  • [BREAKING CHANGE] Elements that constitute the concepts of Customer and Salesperson
    • Endpoints /data/customers and /data/salespeople
    • Schemas Customer and Salesperson
    • Tags customers and salespeople
  • [BREAKING CHANGE] Auth-related resources
    • Paths
      • /public/guest
      • /public/register
      • /public/login
      • /access
      • /access/{resource}
    • Unusedd tags
      • authorization
      • session