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(specs): add acl permissions to operations #2555

Merged
merged 4 commits into from
Jan 17, 2024
Merged

Conversation

kai687
Copy link
Contributor

@kai687 kai687 commented Jan 16, 2024

🧭 What and Why

Add extension x-acl to each endpoint to document which ACL the API key needs to run it.
Can be used for documentation.

🎟 JIRA Ticket: DOC-1330

Changes included:

  • Adds new field x-acl to each path
  • Some unrelated whitespace removal due to autoformatting in my editor

Copy link

netlify bot commented Jan 16, 2024

Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit 23e5453
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/65a7a90010da6300084b93e1
😎 Deploy Preview https://deploy-preview-2555--api-clients-automation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@algolia-bot
Copy link
Collaborator

algolia-bot commented Jan 16, 2024

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

@kai687 kai687 marked this pull request as ready for review January 16, 2024 19:11
@kai687 kai687 requested a review from a team as a code owner January 16, 2024 19:11
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

that's huge!! love the idea

we've added a custom eslint rule in #2557 in order to validate them for later iteration, we will also work on adding this to the description of the methods of the API clients

@shortcuts shortcuts enabled auto-merge (squash) January 17, 2024 09:50
@shortcuts shortcuts merged commit 99e4bdf into main Jan 17, 2024
28 checks passed
@shortcuts shortcuts deleted the feat/specs/acl branch January 17, 2024 10:36
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.

3 participants