Skip to content

Commit e6b11a3

Browse files
sophiadtandreachild
authored andcommitted
Fix for typos mostly in documentation but also a couple command line arguments and one model-scoped variable that had 'neptume' instead of 'neptune'.
1 parent 3e48485 commit e6b11a3

File tree

7 files changed

+23
-23
lines changed

7 files changed

+23
-23
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ To rollback, removing all the AWS resources run:
7777
`neptune-for-graphql --remove-aws-pipeline-name` <*your-new-GraphQL-API-name*>
7878

7979
#### References:
80-
- [here](/doc/routesExample.md) an example using the Air Routes data on Amazon Neptune, showing the outputs of the utility.
80+
- [here](/doc/routesExample.md) is an example using the Air Routes data on Amazon Neptune, showing the outputs of the utility.
8181
- If you are wondering which AWS resources the utility is creating, look at the section below.
8282
- To customize the GraphQL schema, look at the section below.
8383

@@ -89,7 +89,7 @@ You can start from an empty Neptune database and use a GraphQL API to create the
8989
`neptune-for-graphql --input-schema-file `<*your-graphql-schema-file*>` --create-update-aws-pipeline --create-update-aws-pipeline-name` <*your-new-GraphQL-API-name*>` --create-update-aws-pipeline-neptune-endpoint` <*your-neptune-database-endpoint:port*> ` --output-resolver-query-https`
9090

9191
#### References:
92-
- [here](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/todoExample.md) an example using a TODO GraphQL schema, showing the outputs of the utility.
92+
- [here](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/todoExample.md) is an example using a TODO GraphQL schema, showing the outputs of the utility.
9393
- If you are wondering which AWS resources the utility is creating, look at the section below.
9494
- To customize the GraphQL schema, look at the section below.
9595

@@ -113,7 +113,7 @@ In case you don't want your Graph API having the option of updating your databas
113113

114114

115115
### @alias
116-
This directive can be applied to GraphQL schema types or fields. It maps different names between the graph database and the GraphQL schema. The syntax is *@alias(property: your-name)*. In the example below *airport* is the graph database node label mapped to the *Airport* GraphQL type, and *desc* is the property of the graph database node mapped to the field *description*. See the [Air Routes Example](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/routesExample.md). The GraphQL guidence is pascal case for types and camel case for fields.
116+
This directive can be applied to GraphQL schema types or fields. It maps different names between the graph database and the GraphQL schema. The syntax is *@alias(property: your-name)*. In the example below *airport* is the graph database node label mapped to the *Airport* GraphQL type, and *desc* is the property of the graph database node mapped to the field *description*. See the [Air Routes Example](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/routesExample.md). The GraphQL guidance is pascal case for types and camel case for fields.
117117

118118
```graphql
119119
type Airport @alias(property: "airport") {
@@ -160,7 +160,7 @@ type Mutation {
160160
}
161161
```
162162

163-
You can add query or mututation using a Gremlin query. At this time Gremlin queries are limited to return *scalar* values, or *elementMap()* for a single node, or *elementMap().fold()* for a list of nodes.
163+
You can add a query or mutation using a Gremlin query. At this time Gremlin queries are limited to return *scalar* values, or *elementMap()* for a single node, or *elementMap().fold()* for a list of nodes.
164164
```graphql
165165
type Query {
166166
getAirportWithGremlin(code:String): Airport @graphQuery(statement: "g.V().has('airport', 'code', '$code').elementMap()") # single node
@@ -215,7 +215,7 @@ type Mutation {
215215
```
216216

217217
### Re-apply your changes with --input-schema-changes-file
218-
You might want to modify the GraphQL source schema and run the utility again getting the latest schema from your Neptune database. Every time the utility discover the a new graphdb schema it generates a new GraphQL schema. To inject your changes, you can manually edit the GraphQL source schema, and run the utility again using it as input instead of the Neptune database endpoint, or write your changes the file format below. As you run the utility with the option `--input-schema-changes-file <value>`, your changes will be applied at once.
218+
You might want to modify the GraphQL source schema and run the utility again to get the latest schema from your Neptune database. Every time the utility discovers a new graphdb schema, it generates a new GraphQL schema. To inject your changes, you can manually edit the GraphQL source schema and run the utility again, using it as input instead of the Neptune database endpoint, or write your changes in the format below. As you run the utility with the added option `--input-schema-changes-file <your-changes-file>`, your changes will be applied at once.
219219
```json
220220
[
221221
{ "type": "graphQLTypeName",
@@ -260,15 +260,15 @@ Independently of the method you or the utility will need to create the following
260260
With the CLI option `--create-update-aws-pipeline`, and its accesory options ([see the commands reference](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/cliReference.md)), the utility automatically creates the resources.<br>
261261
You need to run the utility from a shell in which you installed the AWS CLI, and it is configured for a user with the permission of creating AWS resources. <br>
262262
The utility creates a file with the list of resources named *pipeline-name.resources.json*. Then it uses the file to modify the existing resources when the user runs the command again, or when the user wants to delete the AWS resources with the command option `--remove-aws-pipeline-name <value>`.
263-
The code of the utiliy uses the JavaScript AWS sdk v3, if you'd like to review the code is only in [this file](https://github.com/aws/amazon-neptune-for-graphql/blob/main/src/pipelineResources.js).
263+
The code of the utility uses the JavaScript AWS sdk v3, if you'd like to review the code is only in [this file](https://github.com/aws/amazon-neptune-for-graphql/blob/main/src/pipelineResources.js).
264264

265265
### I prefer a CDK file
266266
To option to trigger the creation of the CDK file starts with `--output-aws-pipeline-cdk`, and its accessory options ([see the commands reference](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/cliReference.md)). <br>
267267
After you ran it, you will find in the *output* folder the file *CDK-pipeline-name-cdk.js* and *CDK-pipeline-name.zip*. The ZIP file is the code for the Lambda function.
268268
See CDK end to end example [here](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/cdk.md).
269269

270270
### Let me setup the resources manually or with my favorite DevOps toolchain
271-
[Here](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/resources.md) the detailed list of resorces needed to configure the GraphQL API pipeline.
271+
[Here](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/resources.md) the detailed list of resources needed to configure the GraphQL API pipeline.
272272
<br>
273273

274274
# Known limitations
@@ -290,7 +290,7 @@ A copy of the License is located at http://www.apache.org/licenses/LICENSE-2.0
290290
or in the "license" file accompanying this file. This file is distributed
291291
on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
292292
express or implied. See the License for the specific language governing
293-
permissions and limitations under the License. [Full licence page](/LICENSE.txt).
293+
permissions and limitations under the License. [Full license page](/LICENSE.txt).
294294
<br>
295295

296296
# Contributing

doc/cdk.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Example starting from an Amazon Neptune database endpoint. In this case the util
1111

1212
Example starting from a GraphQL schema.
1313

14-
`neptune-for-graphql --input-schema-file `<*your-graphql-schema-file*>` --output-aws-pipeline-cdk --output-aws-pipeline-cdk-name` <*your-new-GraphQL-API-name*>` --output-aws-pipeline-cdk-neptume-endpoint` <*your-neptune-database-endpoint:port*>` --output-resolver-query-https`
14+
`neptune-for-graphql --input-schema-file `<*your-graphql-schema-file*>` --output-aws-pipeline-cdk --output-aws-pipeline-cdk-name` <*your-new-GraphQL-API-name*>` --output-aws-pipeline-cdk-neptune-endpoint` <*your-neptune-database-endpoint:port*>` --output-resolver-query-https`
1515

1616

1717

doc/cliReference.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The GraphQL schema with or without directives as data or file name.
2020

2121
`--input-schema-changes-file <value>, -isc <value>`
2222
<br>
23-
The file that contains your GraphQL schema changes to be applied when you run the utility multiple time. When you run the utility poiniting to a database multiple times, and you manually changed the GraphQL source schema, maybe adding a custom query, your chnages will be lost. To avoid it, add your changes to the a json file and pass it to this option. See section [*Re-apply your changes*](#re-apply-your-changes-with---input-schema-changes-file) for the file format.
23+
The file that contains your GraphQL schema changes to be applied when you run the utility multiple time. When you run the utility pointing to a database multiple times, and you manually changed the GraphQL source schema, maybe adding a custom query, your changes will be lost. To avoid it, add your changes to the a json file and pass it to this option. See section [*Re-apply your changes*](#re-apply-your-changes-with---input-schema-changes-file) for the file format.
2424

2525
```json
2626
[
@@ -64,7 +64,7 @@ The graphdb schema as data or file name. Instead of pointing to a Neptune databa
6464

6565
`--input-graphdb-schema-neptune-endpoint <value>, -ie <value>`
6666
<br>
67-
The Neptune database enpoint from which the utility extract the graphdb schema. Format: `host:port`
67+
The Neptune database endpoint from which the utility extract the graphdb schema. Format: `host:port`
6868

6969
## Output options
7070
`--output-folder-path <value>, -o <value>`
@@ -81,7 +81,7 @@ The file name output for the GraphQL schema with directives. If not specified th
8181

8282
`--output-schema-no-mutations, -onm`
8383
<br>
84-
The inferred GraphQL schema will not have mutuations, just queries.
84+
The inferred GraphQL schema will not have mutations, just queries.
8585

8686
`--output-neptune-schema-file <value>, -og <value>`
8787
<br>
@@ -135,7 +135,7 @@ It removes the pipeline created with `--create-update-aws-pipeline`. The resourc
135135
<br>
136136
This trigger the creation of a CDK file to be use to create the AWS resources for the GraphQL API, including the AppSync GraphQL API and the Lambda that run the resolver.
137137

138-
`--output-aws-pipeline-cdk-neptume-endpoint <value>, -ce <value>`
138+
`--output-aws-pipeline-cdk-neptune-endpoint <value>, -ce <value>`
139139
<br>
140140
This set the Neptune database endpoint used by the Lambda function to query the Neptune database. If not set it used the endpoint set with `--input-graphdb-schema-neptune-endpoint`.
141141

src/help.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ Parameters
141141
142142
[--output-aws-pipeline-cdk -c ]
143143
[--output-aws-pipeline-cdk-name <value> -cn ] default: Neptune DB name from --input-graphdb-schema-neptune-endpoint if exists
144-
[--output-aws-pipeline-cdk-neptume-endpoint <value> -ce ] default: --input-graphdb-schema-neptune-endpoint if exists
145-
[--output-aws-pipeline-cdk-neptume-database-name <value> -cd ]
144+
[--output-aws-pipeline-cdk-neptune-endpoint <value> -ce ] default: --input-graphdb-schema-neptune-endpoint if exists
145+
[--output-aws-pipeline-cdk-neptune-database-name <value> -cd ]
146146
[--output-aws-pipeline-cdk-region <value> -cr ] default: us-east-1 or from --input-graphdb-schema-neptune-endpoint if exists
147147
[--output-aws-pipeline-cdk-file <value> -cf ] default: --output-aws-pipeline-cdk-name <value>-cdk.js
148148
[--output-aws-pipeline-cdk-neptune-IAM -ci ] default: is Neptune VPC

src/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -202,11 +202,11 @@ function processArgs() {
202202
inputCDKpipeline = true;
203203
break;
204204
case '-ce':
205-
case '--output-aws-pipeline-cdk-neptume-endpoint':
205+
case '--output-aws-pipeline-cdk-neptune-endpoint':
206206
inputCDKpipelineEnpoint = array[index + 1];
207207
break;
208208
case '-cd':
209-
case '--output-aws-pipeline-cdk-neptume-database-name':
209+
case '--output-aws-pipeline-cdk-neptune-database-name':
210210
inputCDKpipelineDatabaseName = array[index + 1];
211211
break;
212212
case '-cn':

src/pipelineResources.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ let NEPTUNE_PORT = null;
6666
let NEPTUNE_DBSubnetGroup = null;
6767
let NEPTUNE_DBSubnetIds = [];
6868
let NEPTUNE_VpcSecurityGroupId = null;
69-
let NEPTUME_IAM_AUTH = false;
69+
let NEPTUNE_IAM_AUTH = false;
7070
let NEPTUNE_CURRENT_VERSION = '';
7171
let NEPTUNE_CURRENT_IAM = false;
7272
let NEPTUNE_IAM_POLICY_RESOURCE = '*';
@@ -235,7 +235,7 @@ async function createLambdaRole() {
235235
if (!quiet) spinner.succeed(`Attached ${yellow('AWSLambdaBasicExecutionRole')} to Lambda Role`);
236236

237237

238-
if (NEPTUME_IAM_AUTH) {
238+
if (NEPTUNE_IAM_AUTH) {
239239
// Create Neptune query policy
240240
if (!quiet) spinner = ora('Creating policy for Neptune queries ...').start();
241241
let command = new CreatePolicyCommand({
@@ -313,7 +313,7 @@ async function createLambdaFunction() {
313313
if (!quiet) spinner = ora('Creating Lambda function ...').start();
314314

315315
let params;
316-
if (NEPTUME_IAM_AUTH) {
316+
if (NEPTUNE_IAM_AUTH) {
317317
params = {
318318
Code: {
319319
ZipFile: ZIP
@@ -805,7 +805,7 @@ async function createUpdateAWSpipeline (pipelineName, neptuneDBName, neptuneDBre
805805
RESOURCES_FILE = `${outputFolderPath}/${NAME}-resources.json`;
806806
ADD_MUTATIONS = addMutations;
807807
quiet = quietI;
808-
NEPTUME_IAM_AUTH = isNeptuneIAMAuth;
808+
NEPTUNE_IAM_AUTH = isNeptuneIAMAuth;
809809
NEPTUNE_HOST = neptuneHost;
810810
NEPTUNE_PORT = neptunePort;
811811
thisOutputFolderPath = outputFolderPath;

test/TestCases/Case06/case.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
"--output-folder-path", "./test/TestCases/Case06/output",
77
"--output-aws-pipeline-cdk",
88
"--output-aws-pipeline-cdk-name", "AirportCDKTestJest",
9-
"--output-aws-pipeline-cdk-neptume-database-name", "airport00",
9+
"--output-aws-pipeline-cdk-neptune-database-name", "airport00",
1010
"--output-aws-pipeline-cdk-region", "us-east-1",
11-
"--output-aws-pipeline-cdk-neptume-endpoint", "<AIR_ROUTES_DB_HOST>:<AIR_ROUTES_DB_PORT>",
11+
"--output-aws-pipeline-cdk-neptune-endpoint", "<AIR_ROUTES_DB_HOST>:<AIR_ROUTES_DB_PORT>",
1212
"--output-resolver-query-https"],
1313
"host": "<AIR_ROUTES_DB_HOST>",
1414
"port": "<AIR_ROUTES_DB_PORT>",

0 commit comments

Comments
 (0)