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

Improve REST OpenAPI documentation for auth #4951

Merged
merged 2 commits into from
Feb 22, 2023
Merged

Conversation

kennyadsl
Copy link
Member

Summary

This change will show the correct format of the api key token in the generated documentation.

Before

Screenshot 2023-02-20 at 17 04 17@2x

After

Screenshot 2023-02-20 at 17 07 23@2x

Checklist

Check out our PR guidelines for more details.

The following are mandatory for all PRs:

The following are not always needed:

  • 📖 I have updated the README to account for my changes.
  • 📑 I have documented new code with YARD.
  • 🛣️ I have opened a PR to update the guides.
  • ✅ I have added automated tests to cover my changes.
  • 📸 I have attached screenshots to demo visual changes.

@kennyadsl kennyadsl added type:enhancement Proposed or newly added feature changelog:solidus_api Changes to the solidus_api gem labels Feb 20, 2023
@kennyadsl kennyadsl self-assigned this Feb 20, 2023
@kennyadsl kennyadsl requested a review from a team as a code owner February 20, 2023 16:08
This change will show the correct format of the api key token
in the generated documentation.
@kennyadsl kennyadsl force-pushed the kennyadsl/auth-token-doc branch from 3fd7e0a to 6b1fff0 Compare February 22, 2023 08:24
@github-actions github-actions bot added the changelog:solidus_backend Changes to the solidus_backend gem label Feb 22, 2023
@kennyadsl
Copy link
Member Author

Pushed a new commit to mark another spec as flaky, due to this failure.

@codecov
Copy link

codecov bot commented Feb 22, 2023

Codecov Report

Merging #4951 (6b1fff0) into master (0c52edf) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4951   +/-   ##
=======================================
  Coverage   86.69%   86.69%           
=======================================
  Files         578      578           
  Lines       14681    14681           
=======================================
  Hits        12728    12728           
  Misses       1953     1953           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@kennyadsl kennyadsl merged commit 5d119ba into master Feb 22, 2023
@kennyadsl kennyadsl deleted the kennyadsl/auth-token-doc branch February 22, 2023 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog:solidus_api Changes to the solidus_api gem changelog:solidus_backend Changes to the solidus_backend gem type:enhancement Proposed or newly added feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants