[DOC-2558] docs(GSQLAPI): Add authentication header for GSQL example request;#740
[DOC-2558] docs(GSQLAPI): Add authentication header for GSQL example request;#740ArthurXie-tg wants to merge 1 commit into4.1from
Conversation
victorleeTG
left a comment
There was a problem hiding this comment.
@ArthurXie-tg The page https://docs.tigergraph.com/tigergraph-server/4.1/api/ already explains the authentication requirement/header.
Users should think and want to think of all endpoints as one group; not GSQL endpoints and other endpoints. The rules for endpoints should as uniform as possible and presented in one general "API" page. Of course, we should also have a link from the GSQL endpoints page pointing to the general point.
I recommend that you
- review the rules on this page to see if they are correct.
- add a sentence on the GSQL endpoints page advising them where to look for authentication information.
I have one question:
It is not clear in the examples why you sometimes use username/password and sometimes use a token? It is random, or is there a pattern?
I personally do not like to show -u tigergraph:tigergraph in every example. It is not really a good practice. I would have a note in the Authentication section telling them that this is the default username/password. It should ONLY be user for a private personal deployment where you are not concerned about security. We tell users that they really should change the password, for security reasons.
|
https://graphsql.atlassian.net/browse/DOC-2558