Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Document warnings

See original GitHub issue

This is a…


[ ] Feature request
[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[x ] Documentation issue or request

Description

Add docs for warnings, eg:

Unable to determine the scheme to use: OpenAPI specification does not provide a `schemes’ definition and the specification was uploaded so the originating URL is lost.
Operation PUT /api/fruits/{id} does not provide a response schema for code 201
Operation DELETE /api/fruits/{id} does not provide a response schema for code 204

user is unsure what to do

Issue Analytics

State:
Created 4 years ago
Comments:10 (7 by maintainers)

Top GitHub Comments

1reaction

TovaCohencommented, Dec 2, 2019

If the error message gets reworded, I would use complete sentences, something like:

The OpenAPI document does not define a response type for the xyz operation. You can ignore this if type information is not needed in the integration flow. If type information is needed in the flow, for example to map response data, define the response type in the OpenAPI document.

1reaction

zregvartcommented, Nov 28, 2019

We can certainly reword those messages to make them a bit clearer. @pwright what bits you found unclear that need more explaining?

Other than that we should not be warning about missing response schema for 204, that HTTP status denotes that there will be no response.