You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
API Blueprint renderer will not flag parameters as optional if required: false is set
Why
By default, API Blueprint considers all parameters as required. This change adjusts the API Blueprint view object's logic to set "optional" on a parameter if required: false is set.
note: if this has the potential to be merged in. I will gladly add test and offer further explanation if needed
This definitely has potential to be merged in. Does blueprint treat all values as required unless optional is present? Just want to make sure we don't break it in the opposite direction.
I am struggling a little bit to resolve this last failing cucumber feature but I cannot find the generated doc/api/index.apib which this feature spec compares against.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What Changed
API Blueprint renderer will not flag parameters as
optional
ifrequired: false
is setWhy
By default, API Blueprint considers all parameters as required. This change adjusts the API Blueprint view object's logic to set "optional" on a parameter if
required: false
is set.note: if this has the potential to be merged in. I will gladly add test and offer further explanation if needed