-
Notifications
You must be signed in to change notification settings - Fork 5
Getting started documentation #82
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
Conversation
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 took a pass just reading. Take or leave the minor sentence tweaks.
I haven't yet done a complete tour actually using the playground.
| hosts | strings | DATA_API_HOSTS | Hosts for connecting to the database | | ||
| username | string | DATA_API_USERNAME | connect with database username | | ||
| keyspace | string | DATA_API_KEYSPACE | Only allow access to a single keyspace | | ||
| excluded-keyspaces | strings | DATA_API_EXCLUDED_KEYSPACES | Keyspaces to exclude from the endpoint | |
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.
Is it obvious how these keyspaces should be formatted in lists for environment variables, vs. config file?
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.
Same comment for "hosts"
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.
Good suggestion. I've added some more explanation for that type (w/ examples) in the Settings
section.
graphql/README.md
Outdated
|
||
### Conditional Inserts, Updates, and Deletes | ||
|
||
Condition mutations are mechanism to add or modify field values only when a |
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.
"Conditional mutations are a mechanism.."
?
README.md
Outdated
|
||
## Configuration | ||
|
||
There are a few ways configuration can be provided. When using Docker, settings |
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.
Configuration for Docker can be done using either environment variables or a mounted configuration file.
graphql/README.md
Outdated
* `books()`: Query book values by equality. If no `value` argument is provided | ||
then the first 100 (default pagesize) values are returned. | ||
|
||
* `booksFilter`: Query book values by filtering the result with relational |
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.
relational == non-equality
graphql/README.md
Outdated
|
||
### Filtering | ||
|
||
Filter queries allow for the use of relational operators to control which values |
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.
again, consider using non-equality operators rather than relational operators
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.
It's looking great!
I've added some suggestions, doubts and questions below.
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.
Looks great!
Feel free to merge it ahead of the others and we can rebase the rest.
Grammatical fixes and better wording
README.md
Outdated
# Or (with a cluster bound to 0.0.0.0) | ||
run --network host -e "ENDPOINT_HOSTS=127.0.0.1" cassandra-data-apis | ||
# With a cluster bound to 0.0.0.0 | ||
run --network host -e "DATA_API_HOSTS=127.0.0.1" cassandra-data-apis |
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.
Nit: change to
docker run --network host -e "DATA_API_HOSTS=127.0.0.1" cassandra-data-apis
do we need -p 8080:8080
too? looks like no based on this warning
WARNING: Published ports are discarded when using host network mode
Landed in: aa0655d |
Mostly centered around GraphQL