Skip to content
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

feat: openapi: 3.1.0 summary and description fields for refs #1030

Merged
merged 2 commits into from
Dec 22, 2021

Conversation

bfanger
Copy link
Collaborator

@bfanger bfanger commented Dec 17, 2021

  • Changed default version to openapi: 3.1.0
  • When specified, output the summary and/or description fields alongside the ref

Related to #885

@DerManoMann
Copy link
Collaborator

@bfanger I'll fix the conflicts and review today/tomorrow.

@DerManoMann
Copy link
Collaborator

Looking good to me - will be fun merging into PR #1024 but I guess that is my problem :)

Speaking of problems - spectral raises a couple new, 3.1.0 related issues with this PR - I guess we can tackle those in follow up PRs...

@DerManoMann
Copy link
Collaborator

Ah, forgot to mention that I'd like to merge this and #1024 together and then create 4.1.0 after that unless there is reason that the spec version change to 3.1.0 should be a major version bump.

@DerManoMann DerManoMann self-requested a review December 20, 2021 03:27
Copy link
Collaborator

@DerManoMann DerManoMann left a comment

Choose a reason for hiding this comment

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

I suppose it will make a few people happy :)

@DerManoMann DerManoMann mentioned this pull request Dec 20, 2021
$defaultValues = get_class_vars(get_class($this));
foreach (['summary', 'description'] as $prop) {
if (property_exists($this, $prop)) {
if ($this->$prop !== $defaultValues[$prop]) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just a question: Is there any value in looking up default values this convoluted way? After all we know that Generator::UNDEFINEDis the default value...

@DerManoMann DerManoMann merged commit c4b6729 into master Dec 22, 2021
@DerManoMann DerManoMann deleted the feature/3.1.0-refs branch December 22, 2021 19:31
GuilhemN added a commit to GuilhemN/swagger-php that referenced this pull request Jan 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants