Skip to content

Commit e190d62

Browse files
committed
Added new apollo arg to help and readme.
1 parent 121b464 commit e190d62

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -275,15 +275,24 @@ See CDK end to end example [here](https://github.com/aws/amazon-neptune-for-grap
275275
# Generate Apollo Server Artifacts
276276
If you prefer to use Apollo Server instead of AWS App Sync, the utility can generate a ZIP file of Apollo Server artifacts with the CLI option `--create-update-apollo-server` for a standalone server or `--create-update-apollo-server-subgraph` for federated systems.
277277

278-
For example:
278+
Example of starting with a neptune database with data from which to determine the graphQL schema:
279279
```
280280
neptune-for-graphql \
281281
--input-graphdb-schema-neptune-endpoint abc.us-west-2.neptune.amazonaws.com:8182 \
282282
--create-update-apollo-server \
283283
--output-resolver-query-https
284284
```
285285

286-
The command above will generate an `apollo-server-<identifier>-<timestamp>.zip` file which can then be deployed locally by following these steps:
286+
Example of starting with a graphQL schema file:
287+
```
288+
neptune-for-graphql \
289+
--input-schema-file airports.source.schema.graphql
290+
--create-update-apollo-server-neptune-endpoint abc.us-west-2.neptune.amazonaws.com:8182 \
291+
--create-update-apollo-server \
292+
--output-resolver-query-https
293+
```
294+
295+
The example commands above will generate an `apollo-server-<identifier>-<timestamp>.zip` file which can then be deployed locally by following these steps:
287296
1. unzip `apollo-server-<identifier>-<timestamp>.zip`
288297
2. change directory into the unzipped folder
289298
3. execute `npm install` to install required dependencies

src/help.js

+1
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ Parameters
146146
147147
[--create-update-apollo-server -asvr]
148148
[--create-update-apollo-server-subgraph -asub]
149+
[--create-update-apollo-server-neptune-endpoint -ase ] default: --input-graphdb-schema-neptune-endpoint if exists
149150
[ ... more apollo options to come in future roadmap ]
150151
151152
[--output-aws-pipeline-cdk -c ]

0 commit comments

Comments
 (0)