Swagger Spec Compatibility
master

Content:

  • Errors description
    • Request Contract Changes
      • [REQ-E001] - Added Required Property in Request contract
      • [REQ-E002] - Removed Enum value from Request contract
      • [REQ-E003] - Removing properties from an object with additionalProperties set to False used as request parameter
    • Response Contract Changes
      • [RES-E001] - Added properties in an object with additionalProperties set to False used in response
      • [RES-E002] - Remove a required property from an object used in responses
      • [RES-E003] - Added Enum value in Response contract
    • Miscellaneous Changes
      • [MIS-E001] - Delete an endpoint
      • [MIS-E002] - Changed type
  • API reference
  • Changelog
Swagger Spec Compatibility
  • Docs »
  • Errors description
  • Edit on GitHub

Errors description¶

Request Contract Changes¶

  • [REQ-E001] - Added Required Property in Request contract
    • Rationale
    • Mitigation
    • Example
  • [REQ-E002] - Removed Enum value from Request contract
    • Rationale
    • Mitigation
    • Example
  • [REQ-E003] - Removing properties from an object with additionalProperties set to False used as request parameter
    • Rationale
    • Mitigation
    • Example

Response Contract Changes¶

  • [RES-E001] - Added properties in an object with additionalProperties set to False used in response
    • Rationale
    • Mitigation
    • Example
  • [RES-E002] - Remove a required property from an object used in responses
    • Rationale
    • Mitigation
    • Example
  • [RES-E003] - Added Enum value in Response contract
    • Rationale
    • Mitigation
    • Example

Miscellaneous Changes¶

  • [MIS-E001] - Delete an endpoint
    • Rationale
    • Mitigation
    • Example
  • [MIS-E002] - Changed type
    • Rationale
    • Mitigation
    • Example
Next Previous

© Copyright 2018, Yelp, Inc. Revision 13debf28.

Built with Sphinx using a theme provided by Read the Docs.