diff --git a/README.md b/README.md index 1651c60e..0f0a7512 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ -![GitHub last commit](https://img.shields.io/github/last-commit/strongloop/oasgraph.svg?style=flat) -![Travis (.org)](https://img.shields.io/travis/strongloop/oasgraph.svg?style=flat) +![GitHub last commit](https://img.shields.io/github/last-commit/ibm/openapi-to-graphql.svg?style=flat) +![Travis (.org)](https://img.shields.io/travis/ibm/openapi-to-graphql.svg?style=flat) [![Join the chat at https://gitter.im/oasgraph/Lobby](https://badges.gitter.im/oasgraph/Lobby.svg?style=flat)](https://gitter.im/oasgraph/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +# Please note: OASGraph has been renamed to [OpenAPI-to-GraphQL](https://github.com/IBM/openapi-to-graphql). # OASGraph Translate APIs described by [OpenAPI Specifications (OAS)](https://github.com/OAI/OpenAPI-Specification) into [GraphQL](https://graphql.org/). -Overview of translation +Overview of translation ## Getting started @@ -58,32 +59,32 @@ Here are some guides to further help you get started: * **Data-centric** The GraphQL interface is created around the data definitions in the given OAS, not around the endpoints, leading to a natural use of GraphQL. - Example of data-centric design + Example of data-centric design * **Nested data** [Links](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#linksObject) defined in the OAS are used to compose data definitions. Furthermore, hierarchical path structures can be used to nest data via the [`addSubOperations`](./packages/oasgraph/README.md#options-addsuboperations) option. - Example of links resolution + Example of links resolution * **Automatic query resolution** Automatically generated resolvers translate (nested) GraphQL queries to API requests. Request results are translated back to GraphQL responses. - Example of query resolution + Example of query resolution * **Mutations** Non-safe, non-idempotent API operations (e.g., `POST`, `PUT`, `DELETE`) are translated to GraphQL [mutations](http://graphql.org/learn/queries/#mutations). Input payload is type-checked. - Example of mutation + Example of mutation * **Authentication** OASGraph currently supports authentication via API Key and basic auth. OASGraph wraps secured endpoints into a `viewer`, which takes the API key / credentials as input. - Example of authentication + Example of authentication * **API Sanitation** Parts of an API that not compatible with GraphQL are automatically sanitized. For example, API parameters and data definition names with unsupported characters (e.g., `-`, `.`, `,`, `:`, `;`...) are removed. GraphQL queries are desanitized to correctly invoke the REST API and the responses are resanitized to create GraphQL-compliant results. - Example of sanitation + Example of sanitation * **Custom request options** Provide headers and query parameters to send with every API request. This allows, for example, to handle authentication or tag requests from GraphQL. diff --git a/packages/oasgraph-cli/README.md b/packages/oasgraph-cli/README.md index e1ac250b..bd6decc8 100644 --- a/packages/oasgraph-cli/README.md +++ b/packages/oasgraph-cli/README.md @@ -1,14 +1,15 @@ -![Travis (.org)](https://img.shields.io/travis/strongloop/oasgraph.svg?style=flat) +![Travis (.org)](https://img.shields.io/travis/ibm/openapi-to-graphql.svg?style=flat) [![npm](https://img.shields.io/npm/v/oasgraph-cli.svg?style=flat)](https://www.npmjs.com/package/oasgraph-cli) [![Join the chat at https://gitter.im/oasgraph/Lobby](https://badges.gitter.im/oasgraph/Lobby.svg?style=flat)](https://gitter.im/oasgraph/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +# Please note: OASGraph CLI has been renamed to [OpenAPI-to-GraphQL CLI](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql-cli). # OASGraph CLI Command line interface (CLI) for turning APIs described by [OpenAPI Specification (OAS)](https://github.com/OAI/OpenAPI-Specification) into [GraphQL](https://graphql.org/) interfaces. -Overview of translation +Overview of translation -_Note: To use OASGraph as a library, refer to the [`oasgraph`](https://github.com/strongloop/oasgraph/tree/master/packages/oasgraph) package._ +_Note: To use OASGraph as a library, refer to the [`oasgraph`](https://github.com/ibm/openapi-to-graphql/tree/oasgraph/packages/oasgraph) package._ ## Installation @@ -61,9 +62,9 @@ oasgraph oas.json --save schema.graphql *** -To learn more about the other options, please refer [here](https://github.com/strongloop/oasgraph/tree/master/packages/oasgraph#options). +To learn more about the other options, please refer [here](https://github.com/ibm/openapi-to-graphql/tree/oasgraph/packages/oasgraph#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/strongloop/oasgraph/tree/master/packages/oasgraph#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/oasgraph/packages/oasgraph#usage) does. ## License diff --git a/packages/oasgraph-cli/package.json b/packages/oasgraph-cli/package.json index 32c23580..5bf837e7 100644 --- a/packages/oasgraph-cli/package.json +++ b/packages/oasgraph-cli/package.json @@ -12,9 +12,9 @@ }, "repository": { "type": "git", - "url": "https://github.com/strongloop/oasgraph.git" + "url": "https://github.com/IBM/openapi-to-graphql/tree/oasgraph" }, - "homepage": "https://github.com/strongloop/oasgraph/blob/master/README.md", + "homepage": "https://github.com/IBM/openapi-to-graphql/tree/oasgraph", "keywords": [ "ibm", "strongloop", diff --git a/packages/oasgraph/README.md b/packages/oasgraph/README.md index d5887620..9bdfc26a 100644 --- a/packages/oasgraph/README.md +++ b/packages/oasgraph/README.md @@ -1,14 +1,15 @@ -![Travis (.org)](https://img.shields.io/travis/strongloop/oasgraph.svg?style=flat) +![Travis (.org)](https://img.shields.io/travis/ibm/openapi-to-graphql.svg?style=flat) [![npm](https://img.shields.io/npm/v/oasgraph.svg?style=flat)](https://www.npmjs.com/package/oasgraph) [![Join the chat at https://gitter.im/oasgraph/Lobby](https://badges.gitter.im/oasgraph/Lobby.svg?style=flat)](https://gitter.im/oasgraph/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +# Please note: OASGraph has been renamed to [OpenAPI-to-GraphQL](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql). # OASGraph Generates a [GraphQL schema](https://graphql.org/learn/schema/) for a given [OpenAPI Specification (OAS)](https://github.com/OAI/OpenAPI-Specification). -Overview of translation +Overview of translation -_Note: To use OASGraph via the command line, refer to the [`oasgraph-cli`](https://github.com/strongloop/oasgraph/tree/master/packages/oasgraph-cli) package._ +_Note: To use OASGraph via the command line, refer to the [`oasgraph-cli`](https://github.com/ibm/openapi-to-graphql/tree/oasgraph/packages/oasgraph-cli) package._ ## Installation diff --git a/packages/oasgraph/package.json b/packages/oasgraph/package.json index ac21f6db..2117b620 100644 --- a/packages/oasgraph/package.json +++ b/packages/oasgraph/package.json @@ -12,9 +12,9 @@ }, "repository": { "type": "git", - "url": "https://github.com/strongloop/oasgraph.git" + "url": "https://github.com/IBM/openapi-to-graphql/tree/oasgraph" }, - "homepage": "https://github.com/strongloop/oasgraph/blob/master/README.md", + "homepage": "https://github.com/IBM/openapi-to-graphql/tree/oasgraph", "keywords": [ "ibm", "strongloop",