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

Add a better description for the api key to Stoplight #4847

Conversation

vassalloandrea
Copy link
Contributor

@vassalloandrea vassalloandrea commented Jan 10, 2023

Summary

Some endpoints that are not related to the users can be used without the API key changing the Solidus configuration.
Add the instruction to do it.

Thank you for the help @Jackwitwicky!

Screenshots

Stoplight security schema

image

Authentication.md

image

Checklist

Check out our PR guidelines for more details.

The following are mandatory for all PRs:

  • I have written a thorough PR description.
  • I have kept my commits small and atomic.
  • I have used clear, explanatory commit messages.

The following are not always needed (cross them out if they are not):

- [ ] I have added automated tests to cover my changes.
- [ ] I have opened a PR to update the guides.

  • I have updated the README to account for my changes.
  • I have attached screenshots to demo visual changes.

@vassalloandrea vassalloandrea requested a review from a team as a code owner January 10, 2023 13:45
@github-actions github-actions bot added the changelog:solidus_api Changes to the solidus_api gem label Jan 10, 2023
@vassalloandrea vassalloandrea force-pushed the av/enhance-stoplight-api-key-description branch 2 times, most recently from e479ebe to bed9353 Compare January 10, 2023 13:51
Copy link
Member

@kennyadsl kennyadsl left a comment

Choose a reason for hiding this comment

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

🙏

api/openapi/authentication.md Outdated Show resolved Hide resolved
@vassalloandrea vassalloandrea force-pushed the av/enhance-stoplight-api-key-description branch from bed9353 to 647b60d Compare January 11, 2023 11:15
@waiting-for-dev
Copy link
Contributor

Thanks, @vassalloandrea 🙇 Left a suggestion

@vassalloandrea vassalloandrea requested review from waiting-for-dev and removed request for kennyadsl January 11, 2023 16:04
@waiting-for-dev waiting-for-dev added the type:enhancement Proposed or newly added feature label Jan 16, 2023
@vassalloandrea vassalloandrea force-pushed the av/enhance-stoplight-api-key-description branch from 647b60d to 9870655 Compare January 18, 2023 14:24
@vassalloandrea vassalloandrea requested review from kennyadsl and waiting-for-dev and removed request for waiting-for-dev and kennyadsl January 18, 2023 14:24
Copy link
Contributor

@waiting-for-dev waiting-for-dev left a comment

Choose a reason for hiding this comment

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

Thanks, @vassalloandrea 🙌

@kennyadsl
Copy link
Member

@vassalloandrea I think we are ready to merge, and the CI has finally started. Can you please rebase? 🙏

Some endpoints that are not related to the users can be used without
the api key changing the Solidus configuration.
Add the instruction to do it.
@vassalloandrea vassalloandrea force-pushed the av/enhance-stoplight-api-key-description branch from 9870655 to 4a689de Compare January 20, 2023 08:45
@codecov
Copy link

codecov bot commented Jan 27, 2023

Codecov Report

Merging #4847 (4a689de) into master (c6050d7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4847   +/-   ##
=======================================
  Coverage   86.23%   86.23%           
=======================================
  Files         578      578           
  Lines       14674    14674           
=======================================
  Hits        12654    12654           
  Misses       2020     2020           

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

@kennyadsl kennyadsl merged commit c0f860c into solidusio:master Jan 27, 2023
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 type:enhancement Proposed or newly added feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants