refactor(appsync): graphQLApi to graphqlApi for better snakecasing

BryanPan342 · Aug 31, 2020 · f3c77e3 · f3c77e3
1 parent 34f40b9
commit f3c77e3
Show file tree

Hide file tree

Showing 19 changed files with 95 additions and 96 deletions.
diff --git a/packages/@aws-cdk/aws-appsync/lib/graphqlapi.ts b/packages/@aws-cdk/aws-appsync/lib/graphqlapi.ts
@@ -206,7 +206,7 @@ export interface LogConfig {
 /**
  * Properties for an AppSync GraphQL API
  */
-export interface GraphQLApiProps {
+export interface GraphqlApiProps {
   /**
    * the name of the GraphQL API
    */
@@ -293,7 +293,7 @@ export class IamResource {
    *
    * @param api The GraphQL API to give permissions
    */
-  public resourceArns(api: GraphQLApi): string[] {
+  public resourceArns(api: GraphqlApi): string[] {
     return this.arns.map((arn) => Stack.of(api).formatArn({
       service: 'appsync',
       resource: `apis/${api.apiId}`,
@@ -325,7 +325,7 @@ export interface GraphqlApiAttributes {
  *
  * @resource AWS::AppSync::GraphQLApi
  */
-export class GraphQLApi extends GraphqlApiBase {
+export class GraphqlApi extends GraphqlApiBase {
   /**
    * Import a GraphQL API through this function
    *
@@ -362,9 +362,9 @@ export class GraphQLApi extends GraphqlApiBase {
   /**
    * the URL of the endpoint created by AppSync
    *
-   * @attribute
+   * @attribute GraphQlUrl
    */
-  public readonly graphQlUrl: string;
+  public readonly graphqlUrl: string;
 
   /**
    * the name of the API
@@ -387,7 +387,7 @@ export class GraphQLApi extends GraphqlApiBase {
   private api: CfnGraphQLApi;
   private apiKeyResource?: CfnApiKey;
 
-  constructor(scope: Construct, id: string, props: GraphQLApiProps) {
+  constructor(scope: Construct, id: string, props: GraphqlApiProps) {
     super(scope, id);
 
     const defaultMode = props.authorizationConfig?.defaultAuthorization ??
@@ -409,7 +409,7 @@ export class GraphQLApi extends GraphqlApiBase {
 
     this.apiId = this.api.attrApiId;
     this.arn = this.api.attrArn;
-    this.graphQlUrl = this.api.attrGraphQlUrl;
+    this.graphqlUrl = this.api.attrGraphQlUrl;
     this.name = this.api.name;
     this.schema = props.schema ?? new Schema();
     this.schemaResource = this.schema.bind(this);

diff --git a/packages/@aws-cdk/aws-appsync/lib/schema.ts b/packages/@aws-cdk/aws-appsync/lib/schema.ts
@@ -1,7 +1,7 @@
 import { readFileSync } from 'fs';
 import { Lazy } from '@aws-cdk/core';
 import { CfnGraphQLSchema } from './appsync.generated';
-import { GraphQLApi } from './graphqlapi';
+import { GraphqlApi } from './graphqlapi';
 import { SchemaMode, shapeAddition } from './private';
 import { IIntermediateType } from './schema-base';
 import { ResolvableField } from './schema-field';
@@ -72,7 +72,7 @@ export class Schema {
    *
    * @param api The binding GraphQL Api
    */
-  public bind(api: GraphQLApi): CfnGraphQLSchema {
+  public bind(api: GraphqlApi): CfnGraphQLSchema {
     if (!this.schema) {
       this.schema = new CfnGraphQLSchema(api, 'Schema', {
         apiId: api.apiId,

diff --git a/packages/@aws-cdk/aws-appsync/package.json b/packages/@aws-cdk/aws-appsync/package.json
@@ -98,8 +98,7 @@
       "no-unused-type:@aws-cdk/aws-appsync.ApiKeyConfig",
       "no-unused-type:@aws-cdk/aws-appsync.UserPoolConfig",
       "no-unused-type:@aws-cdk/aws-appsync.UserPoolDefaultAction",
-      "props-physical-name:@aws-cdk/aws-appsync.GraphQLApiProps",
-      "from-method:@aws-cdk/aws-appsync.GraphQLApi"
+      "props-physical-name:@aws-cdk/aws-appsync.GraphqlApiProps"
     ]
   },
   "stability": "experimental",

diff --git a/packages/@aws-cdk/aws-appsync/test/appsync-auth.test.ts b/packages/@aws-cdk/aws-appsync/test/appsync-auth.test.ts
@@ -13,7 +13,7 @@ beforeEach(() => {
 describe('AppSync API Key Authorization', () => {
   test('AppSync creates default api key', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
     });
@@ -24,7 +24,7 @@ describe('AppSync API Key Authorization', () => {
 
   test('AppSync creates api key from additionalAuthorizationModes', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -41,7 +41,7 @@ describe('AppSync API Key Authorization', () => {
 
   test('AppSync does not create unspecified api key from additionalAuthorizationModes', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -55,7 +55,7 @@ describe('AppSync API Key Authorization', () => {
 
   test('appsync does not create unspecified api key with empty additionalAuthorizationModes', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -70,7 +70,7 @@ describe('AppSync API Key Authorization', () => {
 
   test('appsync creates configured api key with additionalAuthorizationModes', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -90,7 +90,7 @@ describe('AppSync API Key Authorization', () => {
 
   test('appsync creates configured api key with additionalAuthorizationModes (not as first element)', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -117,7 +117,7 @@ describe('AppSync API Key Authorization', () => {
   test('appsync fails when empty default and API_KEY in additional', () => {
     // THEN
     expect(() => {
-      new appsync.GraphQLApi(stack, 'api', {
+      new appsync.GraphqlApi(stack, 'api', {
         name: 'api',
         schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
         authorizationConfig: {
@@ -132,7 +132,7 @@ describe('AppSync API Key Authorization', () => {
   test('appsync fails when multiple API_KEY auth modes', () => {
     // THEN
     expect(() => {
-      new appsync.GraphQLApi(stack, 'api', {
+      new appsync.GraphqlApi(stack, 'api', {
         name: 'api',
         schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
         authorizationConfig: {
@@ -148,7 +148,7 @@ describe('AppSync API Key Authorization', () => {
   test('appsync fails when multiple API_KEY auth modes in additionalXxx', () => {
     // THEN
     expect(() => {
-      new appsync.GraphQLApi(stack, 'api', {
+      new appsync.GraphqlApi(stack, 'api', {
         name: 'api',
         schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
         authorizationConfig: {
@@ -166,7 +166,7 @@ describe('AppSync API Key Authorization', () => {
 describe('AppSync IAM Authorization', () => {
   test('Iam authorization configurable in default authorization', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -182,7 +182,7 @@ describe('AppSync IAM Authorization', () => {
 
   test('Iam authorization configurable in additional authorization', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -199,7 +199,7 @@ describe('AppSync IAM Authorization', () => {
   test('appsync fails when multiple iam auth modes', () => {
     // THEN
     expect(() => {
-      new appsync.GraphQLApi(stack, 'api', {
+      new appsync.GraphqlApi(stack, 'api', {
         name: 'api',
         schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
         authorizationConfig: {
@@ -213,7 +213,7 @@ describe('AppSync IAM Authorization', () => {
   test('appsync fails when multiple IAM auth modes in additionalXxx', () => {
     // THEN
     expect(() => {
-      new appsync.GraphQLApi(stack, 'api', {
+      new appsync.GraphqlApi(stack, 'api', {
         name: 'api',
         schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
         authorizationConfig: {
@@ -234,7 +234,7 @@ describe('AppSync User Pool Authorization', () => {
   });
   test('User Pool authorization configurable in default authorization has default configuration', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -258,7 +258,7 @@ describe('AppSync User Pool Authorization', () => {
 
   test('User Pool authorization configurable in default authorization', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -287,7 +287,7 @@ describe('AppSync User Pool Authorization', () => {
 
   test('User Pool authorization configurable in additional authorization has default configuration', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -312,7 +312,7 @@ describe('AppSync User Pool Authorization', () => {
 
   test('User Pool property defaultAction does not configure when in additional auth', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -342,7 +342,7 @@ describe('AppSync User Pool Authorization', () => {
 
   test('User Pool property defaultAction does not configure when in additional auth', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -399,7 +399,7 @@ describe('AppSync User Pool Authorization', () => {
 describe('AppSync OIDC Authorization', () => {
   test('OIDC authorization configurable in default authorization has default configuration', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -421,7 +421,7 @@ describe('AppSync OIDC Authorization', () => {
 
   test('User Pool authorization configurable in default authorization', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -451,7 +451,7 @@ describe('AppSync OIDC Authorization', () => {
 
   test('OIDC authorization configurable in additional authorization has default configuration', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -475,7 +475,7 @@ describe('AppSync OIDC Authorization', () => {
 
   test('User Pool authorization configurable in additional authorization', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {
@@ -507,7 +507,7 @@ describe('AppSync OIDC Authorization', () => {
 
   test('User Pool authorization configurable in with multiple authorization', () => {
     // WHEN
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
       authorizationConfig: {

diff --git a/packages/@aws-cdk/aws-appsync/test/appsync-code-first.test.ts b/packages/@aws-cdk/aws-appsync/test/appsync-code-first.test.ts
@@ -10,10 +10,10 @@ beforeEach(() => {
 });
 
 describe('code-first implementation through GraphQL Api functions`', () => {
-  let api: appsync.GraphQLApi;
+  let api: appsync.GraphqlApi;
   beforeEach(() => {
     // GIVEN
-    api = new appsync.GraphQLApi(stack, 'api', {
+    api = new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
     });
   });
@@ -164,7 +164,7 @@ describe('code-first implementation through Schema functions`', () => {
     schema.addType(test);
     test.addField('dupid', t.dup_id);
 
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema,
     });
@@ -190,7 +190,7 @@ describe('code-first implementation through Schema functions`', () => {
     schema.addType(test);
     test.addField('dupid', t.dup_id);
 
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema,
     });
@@ -215,7 +215,7 @@ describe('code-first implementation through Schema functions`', () => {
       },
     }));
 
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema,
     });
@@ -241,7 +241,7 @@ describe('code-first implementation through Schema functions`', () => {
     }));
 
     test.addField('dupid', t.dup_id);
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema,
     });
@@ -265,7 +265,7 @@ describe('code-first implementation through Schema functions`', () => {
         dupid: t.dup_id,
       },
     }));
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema,
     });
@@ -290,7 +290,7 @@ describe('code-first implementation through Schema functions`', () => {
     }));
 
     test.addField('dupid', t.dup_id);
-    new appsync.GraphQLApi(stack, 'api', {
+    new appsync.GraphqlApi(stack, 'api', {
       name: 'api',
       schema,
     });

diff --git a/packages/@aws-cdk/aws-appsync/test/appsync-dynamodb.test.ts b/packages/@aws-cdk/aws-appsync/test/appsync-dynamodb.test.ts
@@ -10,10 +10,10 @@ function joined(str: string): string {
 
 // GLOBAL GIVEN
 let stack: cdk.Stack;
-let api: appsync.GraphQLApi;
+let api: appsync.GraphqlApi;
 beforeEach(() => {
   stack = new cdk.Stack();
-  api = new appsync.GraphQLApi(stack, 'baseApi', {
+  api = new appsync.GraphqlApi(stack, 'baseApi', {
     name: 'api',
     schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
   });
@@ -75,7 +75,7 @@ describe('DynamoDb Data Source configuration', () => {
     expect(() => {
       api.addDynamoDbDataSource('ds', table);
       api.addDynamoDbDataSource('ds', table);
-    }).toThrow("There is already a Construct with name 'ds' in GraphQLApi [baseApi]");
+    }).toThrow("There is already a Construct with name 'ds' in GraphqlApi [baseApi]");
   });
 });
 
@@ -160,7 +160,7 @@ describe('adding DynamoDb data source from imported api', () => {
 
   test('imported api can add DynamoDbDataSource from id', () => {
     // WHEN
-    const importedApi = appsync.GraphQLApi.fromGraphqlApiAttributes(stack, 'importedApi', {
+    const importedApi = appsync.GraphqlApi.fromGraphqlApiAttributes(stack, 'importedApi', {
       graphqlApiId: api.apiId,
     });
     importedApi.addDynamoDbDataSource('ds', table);
@@ -174,7 +174,7 @@ describe('adding DynamoDb data source from imported api', () => {
 
   test('imported api can add DynamoDbDataSource from attributes', () => {
     // WHEN
-    const importedApi = appsync.GraphQLApi.fromGraphqlApiAttributes(stack, 'importedApi', {
+    const importedApi = appsync.GraphqlApi.fromGraphqlApiAttributes(stack, 'importedApi', {
       graphqlApiId: api.apiId,
       graphqlApiArn: api.arn,
     });