-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: issue #33 postman request descriptions are strings #34
Conversation
A collection description has a "description":{
"$schema":"http://json-schema.org/draft-07/schema#",
"$id":"#/definitions/description",
"description":"A Description can be a raw text, or be an object, which holds the description along with its format.",
"oneOf":[
{
"type":"object",
"title":"Description",
"properties":{
"content":{
"type":"string",
"description":"The content of the description goes here, as a raw string."
},
"type":{
"type":"string",
"description":"Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app."
},
"version":{
"description":"Description can have versions associated with it, which should be put in this property."
}
}
},
{
"type":"string"
},
{
"type":"null"
}
]
}
We should deal with the possible options |
I don't believe we are using the parsed value anyway, so we could remove it from attempting to parse completely Do we have anywhere we can use the description in explore? If we did, we would want to consider what we can support. Will wherever the field is displayed, does it need truncating? can it support alternate content types? do we want to? |
It might depend on if we continue using the flat structure or if we allow nesting (preferred) and have multiple request per API "folder". We could use the API "description" like at: |
Content will be populated, with string value, if not expliclity set.
dd2b973
to
a882228
Compare
good suggestion, implemented
done,
The |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - thanks @YOU54F
No description provided.