-
Notifications
You must be signed in to change notification settings - Fork 351
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 help cards for security commands #1027
Conversation
page="/administration/security/administration/#administration-security-administration-database-privileges" | ||
minVersion="4.0.0" | ||
> | ||
Database administration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume there isnt a specific DENY
section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see there are a few others like this too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's correct. GRANT
, DENY
, and REVOKE
are together in two different sections. One for DB administration (limiting access to specific databases), and the other one for subgraph administration (limiting what kind of queries a role can do).
<> | ||
<p> | ||
The <code>GRANT</code> command allows an administrator to grant a | ||
privilege to a role in order to access an entity. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
entity seems vague. I assume its in the documentation like this too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this is coming from the documentation. From my understanding it's vague on purpose, because entity in this context includes many different things. It can be different types of operations on a database, a type of query, or even a type of query applied to a specific type of node/relationship.
I do agree that is not so clear though. I think access
is not really appropriate, as it's not just that, but other types of operations as well: traverse/read/write/match in the case of graphs, managing indexes&constraints, and other administration operations in the case of databases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah it sounds vague but its not one I can really comment on much more. I guess if you have taken it from the documentation then at least its consistent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 🎉
Adds help cards for the following commands:
Links to the help cards are also added into a new section of the
:help cypher
result card.changelog: Add new Cypher syntax to
:help cypher