Make createGraphQLSchema consistent

Related to #288

Signed-off-by: Alan Cha <[email protected]>

Author: Alan-Cha

README.md

@@ -35,11 +35,11 @@ Use OpenAPI-to-GraphQL as a library in your application to generate GraphQL sche
    ```bash
    npm i -s openapi-to-graphql
    ```
-2. Require OpenAPI-to-GraphQL and use the `createGraphQlSchema` function:
+2. Require OpenAPI-to-GraphQL and use the `createGraphQLSchema` function:
    ```javascript
-   const { createGraphQlSchema } = require("openapi-to-graphql");
+   const { createGraphQLSchema } = require("openapi-to-graphql");
    // load or construct OAS (const oas = ...)
-   const { schema, report } = await createGraphQlSchema(oas);
+   const { schema, report } = await createGraphQLSchema(oas);
    ```
 
 For further details, refer to the [`openapi-to-graphql` documentation](./packages/openapi-to-graphql).

docs/tutorials/watson.md

@@ -21,7 +21,7 @@ const bodyParser = require('body-parser')
 async function startServer () {
   // use OpenAPI-to-GraphQL to create a GraphQL schema:
   const oas = require('path/to/language-translator-v2.json')
-  const {schema} = await OTG.createGraphQlSchema(oas)
+  const {schema} = await OTG.createGraphQLSchema(oas)
 
   // setup Express.js app and serve the schema:
   const app = express()

packages/openapi-to-graphql-cli/README.md

@@ -85,7 +85,7 @@ openapi-to-graphql oas.json -H someHeader:someValue -H anotherHeader:anotherValu
 
 To learn more about the other options, please refer [here](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql#options).
 
-Please note that the CLI tool is mainly used for quick testing and does not offer all the features that [`createGraphQlSchema(oas, options)`](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql#usage) does.
+Please note that the CLI tool is mainly used for quick testing and does not offer all the features that [`createGraphQLSchema(oas, options)`](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql#usage) does.
 
 ## License
 

packages/openapi-to-graphql-cli/lib/openapi-to-graphql.js

@@ -10,7 +10,7 @@ import * as yaml from 'js-yaml'
 import { printSchema } from 'graphql'
 import { Command } from 'commander'
 
-import { createGraphQlSchema } from 'openapi-to-graphql'
+import { createGraphQLSchema } from 'openapi-to-graphql'
 import { Oas2 } from 'openapi-to-graphql/lib/types/oas2'
 import { Oas3 } from 'openapi-to-graphql/lib/types/oas3'
 import { Options } from 'openapi-to-graphql/lib/types/options'
@@ -246,7 +246,7 @@ function startGraphQLServer(
   port: number
 ): void {
   // Create GraphQL interface
-  createGraphQlSchema(oas, options)
+  createGraphQLSchema(oas, options)
     .then(({ schema, report }) => {
       console.log(JSON.stringify(report, null, 2))
 
@@ -281,7 +281,7 @@ function startGraphQLServer(
 
 /**
  * saves a grahpQL schema generated by OpenAPI-to-GraphQL to a file
- * @param {createGraphQlSchema} schema
+ * @param {createGraphQLSchema} schema
  */
 function writeSchema(schema): void {
   fs.writeFile(program.save, printSchema(schema), err => {

packages/openapi-to-graphql-cli/src/openapi-to-graphql.ts

@@ -25,17 +25,17 @@ Note that [`GraphQL.js`](https://github.com/graphql/graphql-js) is a [peer depen
 The basic way to use OpenAPI-to-GraphQL is to pass an OpenAPI Specification (OAS; version 2.0 or 3.0.x) to the `generateGraphQLSchema` function. The function returns a promise that resolves on an object containing the generated GraphQL schema as well as a report about possible issues when generating the schema:
 
 ```javascript
-const { createGraphQlSchema } = require('openapi-to-graphql')
+const { createGraphQLSchema } = require('openapi-to-graphql')
 // load or construct OAS (const oas = ...)
-const { schema, report } = await createGraphQlSchema(oas)
+const { schema, report } = await createGraphQLSchema(oas)
 ```
 
 ---
 
 OpenAPI-to-GraphQL can also create GraphQL interfaces from _multiple_ APIs. To do so, simply provide multiple OpenAPI Specifications.
 
 ```javascript
-const { schema, report } = await createGraphQlSchema([oas, oas2, oas3]])
+const { schema, report } = await createGraphQLSchema([oas, oas2, oas3]])
 ```
 
 ### Example of Serving the Generated GraphQL Schema
@@ -45,7 +45,7 @@ The schema generated by OpenAPI-to-GraphQL can, for example, be served using [Ex
 ```javascript
 const express = require('express')
 const graphqlHTTP = require('express-graphql')
-const { createGraphQlSchema } = require('openapi-to-graphql')
+const { createGraphQLSchema } = require('openapi-to-graphql')
 
 async function main(oas) {
   // generate schema:
@@ -134,7 +134,7 @@ Notice that the slashes in the path `/favoriteBooks/{name}` must be escaped with
 
 ### Options
 
-The `createGraphQlSchema` function takes an optional `options` object as a second argument:
+The `createGraphQLSchema` function takes an optional `options` object as a second argument:
 
 ```javascript
 createGraphQLSchema(oas[, options])

packages/openapi-to-graphql/README.md

@@ -35,6 +35,6 @@ declare type Result = {
 /**
  * Creates a GraphQL interface from the given OpenAPI Specification (2 or 3).
  */
-export declare function createGraphQlSchema(spec: Oas3 | Oas2 | (Oas3 | Oas2)[], options?: Options): Promise<Result>;
+export declare function createGraphQLSchema(spec: Oas3 | Oas2 | (Oas3 | Oas2)[], options?: Options): Promise<Result>;
 export { sanitize, CaseStyle } from './oas_3_tools';
 export { GraphQLOperationType } from './types/graphql';

packages/openapi-to-graphql/lib/index.d.ts

@@ -61,7 +61,7 @@ const translationLog = debug('translation')
 /**
  * Creates a GraphQL interface from the given OpenAPI Specification (2 or 3).
  */
-export async function createGraphQlSchema(
+export async function createGraphQLSchema(
   spec: Oas3 | Oas2 | (Oas3 | Oas2)[],
   options?: Options
 ): Promise<Result> {

packages/openapi-to-graphql/lib/index.js

@@ -24,7 +24,7 @@ let createdSchema
  */
 beforeAll(() => {
   return Promise.all([
-    openAPIToGraphQL.createGraphQlSchema(oas).then(({ schema }) => {
+    openAPIToGraphQL.createGraphQLSchema(oas).then(({ schema }) => {
       createdSchema = schema
     }),
     startServer(PORT)
@@ -125,7 +125,7 @@ test('Get project using API key 1', () => {
 })
 
 test('Get project using API key passed as option - viewer is disabled', async () => {
-  const { schema } = await openAPIToGraphQL.createGraphQlSchema(oas, {
+  const { schema } = await openAPIToGraphQL.createGraphQLSchema(oas, {
     viewer: false,
     headers: {
       access_token: 'abcdef'
@@ -148,7 +148,7 @@ test('Get project using API key passed as option - viewer is disabled', async ()
 })
 
 test('Get project using API key passed in the requestOptions - viewer is disabled', async () => {
-  const { schema } = await openAPIToGraphQL.createGraphQlSchema(oas, {
+  const { schema } = await openAPIToGraphQL.createGraphQLSchema(oas, {
     viewer: false,
     requestOptions: {
       headers: {
@@ -272,7 +272,7 @@ test('Get project using API key 3', async () => {
 })
 
 test('Get project using API key 3 passed as option - viewer is disabled', async () => {
-  const { schema } = await openAPIToGraphQL.createGraphQlSchema(oas, {
+  const { schema } = await openAPIToGraphQL.createGraphQLSchema(oas, {
     viewer: false,
     headers: {
       cookie: 'access_token=abcdef'
@@ -295,7 +295,7 @@ test('Get project using API key 3 passed as option - viewer is disabled', async
 })
 
 test('Get project using API key 3 passed in the requestOptions - viewer is disabled', async () => {
-  const { schema } = await openAPIToGraphQL.createGraphQlSchema(oas, {
+  const { schema } = await openAPIToGraphQL.createGraphQLSchema(oas, {
     viewer: false,
     requestOptions: {
       headers: {
@@ -458,7 +458,7 @@ test('Extract token from context', () => {
   }`
 
   return openAPIToGraphQL
-    .createGraphQlSchema(oas, {
+    .createGraphQLSchema(oas, {
       tokenJSONpath: '$.user.token',
       viewer: true
     })

packages/openapi-to-graphql/src/index.ts

@@ -15,7 +15,7 @@ const oas = require('./fixtures/cloudfunction.json')
 let createdSchema
 
 beforeAll(async () => {
-  const { schema } = await openAPIToGraphQL.createGraphQlSchema(oas)
+  const { schema } = await openAPIToGraphQL.createGraphQLSchema(oas)
   createdSchema = schema
 })
 

packages/openapi-to-graphql/test/authentication.test.ts

@@ -17,7 +17,7 @@ test('Generate schema without problems', () => {
     strict: false
   }
   return openAPIToGraphQL
-    .createGraphQlSchema(oas, options)
+    .createGraphQLSchema(oas, options)
     .then(({ schema }) => {
       expect(schema).toBeTruthy()
     })

packages/openapi-to-graphql/test/cloudfunction.test.ts

@@ -50,7 +50,7 @@ async function checkOas(OASList) {
     let name = oas.info.title
     console.log(`Process "${name}" (${oas['x-file-path']})...`)
     try {
-      let { report } = await openapiToGraphql.createGraphQlSchema(oas, {
+      let { report } = await openapiToGraphql.createGraphQLSchema(oas, {
         strict: false
       })
       results.successes.push({ name, report })