Skip to content

Conversation

@michaelzangl
Copy link
Contributor

@michaelzangl michaelzangl commented Apr 19, 2021

Fixes #5230

Description

This will display the description of oauth endpoints in the authorize dialog.

Motivation and Context

It was just missing, probably a bug / never tested.

How Has This Been Tested?

Tested against an OpenAPI definition created by spring + modified unit test to cover it.

Screenshot

Screenshot

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@mathis-m
Copy link
Contributor

@michaelzangl you add a Screenshot?

@michaelzangl
Copy link
Contributor Author

@michaelzangl you add a Screenshot?

I added one

Copy link
Contributor

@mathis-m mathis-m left a comment

Choose a reason for hiding this comment

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

looks good

@tim-lai
Copy link
Contributor

tim-lai commented Apr 20, 2021

@michaelzangl Thanks for the PR! It looks good to me. However, I am unable to update with the base branch, so could you rebase this PR?

@michaelzangl
Copy link
Contributor Author

@tim-lai done

@tim-lai tim-lai merged commit 5906dfa into swagger-api:master Apr 20, 2021
@tim-lai
Copy link
Contributor

tim-lai commented Apr 21, 2021

@michaelzangl PR merged! Thanks for the contribution!

@michaelzangl michaelzangl deleted the bug/5230-fix-openapi3-auth-missing-description branch April 21, 2021 07:24
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.

OAS 3: oauth2 securityScheme -> description does not appear

3 participants