Open Request: Issues/Inconsistencies with Amazon JSON Schemas

[josh-fisher]

We have noticed a bunch of inconsistencies with amazon's JSON Schemas and we want to use this issue as a way to provide insight into those issues.

If you come across something that is not working because of an inconsistency with the Amazon Ads JSON Schemas, please post it here. We are hoping that this will help us and Amazon fix their Schemas, which will ultimately help us have a better auto-generation process.

Use the following template when submitting:

Endpoint:
/route/to/the/endoint

Schema:
Remote: URL can be found on the amazon ads documentation
Project: /docs/schema/file.json

Issue:
Provide a brief description of the issue/incosistency.

Example:
Provide a snippet of the affected schema area.

[josh-fisher]

Endpoint:
/accounts/dsp/{accountId}/reports

Schema:
Remote: https://dtrnk0o2zy01c.cloudfront.net/openapi/en-us/dest/DSPReports_prod_3p.json
Project: /docs/schemas/dsp-reports.json

Issue:
Based on the documentation, 415 responses are supposed to contain an array of errors. No errors are provided when incorrect Content-Type and Accept header. It’s quite misleading having that in the documentation and expecting a result.

Example:

"DSPReportsError": {
  "description": "The error response object.",
  "type": "object",
  "required": [
    "message"
  ],
  "properties": {
    "requestId": {
      "description": "A unique identifier of the request.",
      "type": "string"
    },
    "message": {
      "description": "A human-readable description of the response.",
      "type": "string"
    },
    "errors": {
      "minItems": 0,
      "maxItems": 100,
      "description": "A list of errors. Please check the values in this field for report validation errors.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DSPReportsSubError"
      }
    }
  }
},

[git-masi]

Library version
1.5.2

Endpoint
/sb/recommendations/targets/brand

Schema
External download
Internal repo link
External docs

Issue
Brand recommendations docs are inaccurate regarding content type. The docs show a special content type but using that gives an error. The workaround is to use application/json

In addition because the schema uses "oneOf" the type of the request is generated incorrectly as uNKNOWNBASETYPE further compounded by the fact that functions further in the call stack require that to be a property of requestParameters making the API hard to work with. The current solution is as follows:

sponsoredBrandsClient.getBrandRecommendations({ uNKNOWNBASETYPE: body } as any, {
	headers: { 'Content-Type': 'application/json' },
});