Conversation
ScanAPI ReportGET https://api.loadsmart.com/healthRequestHeaders
ResponseMetadata
Headers
Content
{
"key": "value",
"fla": "mengo"
}GET https://api.loadsmart.com/healthRequestHeaders
ResponseMetadata
Headers
Content
{
"key": "value",
"fla": "mengo"
}GET https://api.loadsmart.com/healthRequestHeaders
ResponseMetadata
Headers
Content
{
"key": "value",
"fla": "mengo"
} |
| {% for response in responses %} | ||
| {% set request = response.request %} | ||
| ## Request: {{ request.method }} {{ request.url }} | ||
| ## {{ request.method }} {{ request.url }} |
There was a problem hiding this comment.
It would be better to not display the full URL but just the path instead. Good for the 👀.
Something we can do is to pass BASE_URL to the template and strip it from request.url.
There was a problem hiding this comment.
I strongly agree! We can show the base url only once in the top of the file.
| | | | | ||
| |-------------|----------------------------| | ||
| | status code | {{ response.status_code }} | | ||
| | redirect | {{ response.is_redirect }} | |
There was a problem hiding this comment.
I like the idea of having tables for HTTP headers but I'm not so sure yet if this is the best way to display the pieces of information above.
There was a problem hiding this comment.
I like the tables too. I think it is a good way. On Postman, for example, it is a table too
|
@barbosa @camilamaia I don't remember if the markdown table is officially a markdown feature or a Github flavored-like markdown. If it's a GitHub flavor, we need to make sure to reflect on the project README that we generate a GitHub-lib markdown. Which is ok to me, since everybody uses Github. |
|
@djalmaaraujo True. Good point. This is GitHub flavored. Although tables are not part of the Markdown spec, nowadays the majority of the converters (MD to HTML) support that. I like the idea of adding that note to the README file. |
5afdf52 to
4176c52
Compare
|
@camilamaia I believe this is enough for now. Later we can make this better. |
|
@barbosa would you mind to add an entry to the CHANGELOG.md, please? |
|
@camilamaia done 👍 |
The current state can be seen at the comment below.
fixes #60