question

al_444860 avatar image
0 Likes"
al_444860 asked

Notification OpenAPI 3 Contract violates OpenAPI specification

File: https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json

"PayloadDetail": {
        "type": "object",
        "properties": {
          "schemaVersion": {
            "type": "string",
            "description": "The supported schema version."
          },
          "format": {
            "type": "array",
            "description": "The supported format. Presently, JSON is the only supported format.",
            "items": {
              "type": "string",
              "description": " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/notification/types/api:FormatTypeEnum'>eBay API documentation</a>"
            }
          },
          "deliveryProtocol": {
            "type": "string",
            "description": "The supported delivery protocols. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/notification/types/api:ProtocolEnum'>eBay API documentation</a>"
          },
          "deprecated": {
            "type": "boolean",
            "description": "A deprecation indicator."
          }
        },
        "description": "A type that describes the details about a topic's payload."
      }

The components.schemas.PayloadDetail.properties.deprecated actually violates OpenAPI spec. The 'deprecated' property can only be boolean. Because it is a property of 'properties', which is (according to the spec) Property definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced). (see https://swagger.io/specification/#schema-object)



openapispecification
10 |600 characters needed characters left characters exceeded

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

0 Answers

· Write an Answer

Write an Answer

Hint: Notify or tag a user in this post by typing @username.

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.