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

docs(clients): add ACL section to code doc #2576

Merged
merged 10 commits into from Jan 29, 2024
Merged

docs(clients): add ACL section to code doc #2576

merged 10 commits into from Jan 29, 2024

Conversation

millotp
Copy link
Collaborator

@millotp millotp commented Jan 19, 2024

🧭 What and Why

As suggested by @morganleroi and @shortcuts, we can add the required ACLs to the clients doc, above each function.
We can't do that by simply adding it to the {{notes}} because each language has it's own way to handle multiline comments.

I didn't do java for now, because the javadoc is messed up, will do it in another PR

@millotp millotp self-assigned this Jan 19, 2024
@millotp millotp requested a review from a team as a code owner January 19, 2024 14:42
Copy link

netlify bot commented Jan 19, 2024

Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit 637b1cd
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/65b7d5033745a900079132ff
😎 Deploy Preview https://deploy-preview-2576--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 19, 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.

@morganleroi
Copy link
Contributor

Huuuuuuge

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.

so nice

templates/csharp/libraries/httpclient/api.mustache Outdated Show resolved Hide resolved
templates/swift/api.mustache Outdated Show resolved Hide resolved
Copy link
Contributor

@Fluf22 Fluf22 left a comment

Choose a reason for hiding this comment

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

I'm not sure that's the best option for Swift, because it removes a useful short description for some operations.
But this can be looked at later!

@millotp millotp merged commit b3d6112 into main Jan 29, 2024
28 checks passed
@millotp millotp deleted the doc/acl branch January 29, 2024 17:10
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.

None yet

5 participants