Skip to content

Fix addDescription step #627

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

Merged
merged 2 commits into from
Sep 1, 2021
Merged

Fix addDescription step #627

merged 2 commits into from
Sep 1, 2021

Conversation

delvedor
Copy link
Member

@delvedor delvedor commented Sep 1, 2021

This pr updates the addDescription step of the compiler which wasn't updated with the last iteration of the spec.
Now, if a path or query parameter does not contain a description in the input specification, the description will be pulled from the rest-api-spec.

@delvedor delvedor requested a review from a team September 1, 2021 06:33
Copy link
Contributor

@philkra philkra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@delvedor delvedor merged commit 89a1e48 into main Sep 1, 2021
@delvedor delvedor deleted the fix-description-step branch September 1, 2021 08:20
github-actions bot pushed a commit that referenced this pull request Sep 1, 2021
@ezimuel
Copy link
Contributor

ezimuel commented Sep 1, 2021

@delvedor we also discussed collecting the missing description in a log file to forward to the docs team. I think we should open an issue to track this improvement, WDYT?

@delvedor
Copy link
Member Author

delvedor commented Sep 1, 2021

I'm not against creating such file, but I think is useless, at least for now. We are missing the descriptions for so many parameters that it would be a massive logfile that no one will read.
Eventually, we will have more descriptions, while keeping the spec updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants