Skip to content

Commit

Permalink
Update VTEX - Marketplace APIs - Suggestions.json
Browse files Browse the repository at this point in the history
  • Loading branch information
anabaarbosa committed Sep 27, 2024
1 parent 3052663 commit 6ced489
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion VTEX - Marketplace APIs - Suggestions.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"/suggestions/configuration/autoapproval/toggle": {
"get": {
"tags": [
"SKU Approval Settings"
"SKU approval settings"
],
"summary": "Get autoApprove status in account settings",

Check warning on line 27 in VTEX - Marketplace APIs - Suggestions.json

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

summaries-should-be-in-sentence-case

All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
"description": "This endpoint can be used to check whether the autoapprove setting is active or not, for a specific seller. \n\nIf the response is `true`, the autoapprove setting is active. If the response is `false`, it is inactive.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| ---------- | ------------ | ------------ |\r\n| Channels | UI resources | **Save suggestion rules** |\r\n| Suggestion| Suggestion resources | **Main access** |\r\n\r\nThere are no applicable [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
Expand Down

0 comments on commit 6ced489

Please sign in to comment.