Speakeasy OpenAPI Suggestions -Suggest Hightouch Spec #15
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| "requestBodies": {}, | ||
| "responses": {}, | ||
| "schemas": { | ||
| "Destination": { |
There was a problem hiding this comment.
Error 1: missing-examples - Missing example for component. Consider adding an example
Suggestion 1: Add an example to the Destination component under the schemas. The example includes properties id, name, slug, and workspaceId.
Explanation 1: The error message indicated that there was a missing example for a component. The component 'Destination' was identified as missing an example. An example was created using the properties of the 'Destination' component and added to the schema using a JSON patch.
| "type": "object", | ||
| "additionalProperties": false, | ||
| "example": { | ||
| "id": "123", |
There was a problem hiding this comment.
Error 2: missing-examples - Missing example for component. Consider adding an example
Suggestion 2: Add an example to the ValidateErrorJSON component. The example should be an object with a message property set to Validation failed and a details property set to an empty object.
Explanation 2: The ValidateErrorJSON component is missing an example. By adding an example that is a valid instance of the ValidateErrorJSON schema, the validation error should be resolved.
| } | ||
| }, | ||
| "required": [ | ||
| "message", |
There was a problem hiding this comment.
Error 3: missing-examples - Missing example for component. Consider adding an example
Suggestion 3: Add an example to the InternalServerError component. The example should be 'Internal Server Error', which is a valid value for this component.
Explanation 3: The validation error indicated that the InternalServerError component was missing an example. Adding an example that is a valid value for this component resolves the error.
Generated OpenAPI Suggestions by Speakeasy CLI.
Outputs changes to ./openapi.yaml.