issue#520: Update docs for auth0_role permissions #524
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #524 +/- ##
=======================================
Coverage 85.36% 85.37%
=======================================
Files 75 75
Lines 9923 9926 +3
=======================================
+ Hits 8471 8474 +3
Misses 1147 1147
Partials 305 305
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
sergiught
changed the title
Widcket
reviewed
Mar 13, 2023
internal/auth0/role/resource.go
Outdated
| Description: "Name of the permission (scope) configured on the resource server. " + | ||
| "If referencing a scope from an `auth0_resource_server` resource, " + | ||
| "use the `value` property, " + | ||
| "e.g. `auth0_resource_server.my_resource_server.scopes[0].value`.", |
There was a problem hiding this comment.
Suggested change
| "e.g. `auth0_resource_server.my_resource_server.scopes[0].value`.", | |
| "for example `auth0_resource_server.my_resource_server.scopes[0].value`.", |
There was a problem hiding this comment.
Docs guidelines specify not to use latin abbreviations.
Widcket
reviewed
Mar 13, 2023
docs/resources/role.md
Outdated
| @@ -68,7 +68,7 @@ resource "auth0_role" "my_role" { | |||
|
|
|||
| Required: | |||
|
|
|||
| - `name` (String) Name of the permission (scope). | |||
| - `name` (String) Name of the permission (scope) configured on the resource server. If referencing a scope from an `auth0_resource_server` resource, use the `value` property, e.g. `auth0_resource_server.my_resource_server.scopes[0].value`. | |||
There was a problem hiding this comment.
Suggested change
| - `name` (String) Name of the permission (scope) configured on the resource server. If referencing a scope from an `auth0_resource_server` resource, use the `value` property, e.g. `auth0_resource_server.my_resource_server.scopes[0].value`. | |
| - `name` (String) Name of the permission (scope) configured on the resource server. If referencing a scope from an `auth0_resource_server` resource, use the `value` property, for example `auth0_resource_server.my_resource_server.scopes[0].value`. |
Docs guidelines specify not to use latin abbreviations.
Widcket
approved these changes
Mar 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔧 Changes
Improves the documentation we have for the
auth0_role.permissionsto explicitly call out that permission name can be referenced from theauth0_resource_serverscope value property.📚 References
🔬 Testing
📝 Checklist