sendgrid-oai
sendgrid-oai copied to clipboard
OAS v3 spec (`oas_v3.json`) is invalid
Issue Summary
When running oas_v3.json
through swagger-parser there are a few validation issues. The biggest one is that the properties of the components
object (e.g. parameters
, responses
, requestBodies
, etc.) must have values that are maps of strings to objects or references. And actually in OAS 3.1.0 the schemas
property looks like it must be a map of strings to objects, i.e. references aren't allowed. In your oas_v3.json the values of these properties are just reference objects. The relevant section of the OAS 3.1.0 spec is here: https://spec.openapis.org/oas/v3.1.0#componentsObject
Additionally tags
has a duplicate entry with name "Segmenting Contacts"
.
I have manually fixed these issues locally and can submit a pull request, but if you have an automated system that generates the oas_v3.json
file the it would naturally be better to fix these issues there at the source.
Ahoy! Thank you for opening your first issue here! If this request is regarding troubleshooting your application, please reach out to the support team via https://support.twilio.com. Please note that this repo accepts Issues; however external Pull Requests cannot be accepted because the code is generated using Twilio SendGrid's tooling.
Additionally
tags
has a duplicate entry with name"Segmenting Contacts"
.
This has been a problem for us as well as it prevents the file from being opened in ApiMatic and converted to v3.0.
I've additionally found the following issues:
- https://github.com/sendgrid/sendgrid-oai/issues/121