From c2f51da6952e51495928646fc7eb3b0bbfaba504 Mon Sep 17 00:00:00 2001 From: Alan Cha Date: Thu, 20 Jun 2019 13:52:11 -0400 Subject: [PATCH] Fix links Signed-off-by: Alan Cha --- README.md | 16 ++++++++-------- packages/openapi-to-graphql-cli/README.md | 8 ++++---- packages/openapi-to-graphql-cli/package.json | 4 ++-- packages/openapi-to-graphql/README.md | 4 ++-- packages/openapi-to-graphql/package.json | 4 ++-- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index beeeda91..4a33d222 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![GitHub last commit](https://img.shields.io/github/last-commit/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/IBM/openapi-to-graphql](https://badges.gitter.im/IBM/openapi-to-graphql.svg?style=flat)](https://gitter.im/IBM/openapi-to-graphql?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -6,7 +6,7 @@ Translate APIs described by [OpenAPI Specifications (OAS)](https://github.com/OAI/OpenAPI-Specification) or [Swagger](https://swagger.io/specification/v2/) into [GraphQL](https://graphql.org/). -Overview of translation +Overview of translation ## Getting started @@ -57,32 +57,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/openapi-to-graphql/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** OpenAPI-to-GraphQL currently supports authentication via API Key and basic auth. OpenAPI-to-GraphQL 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/openapi-to-graphql-cli/README.md b/packages/openapi-to-graphql-cli/README.md index 63966cec..c3193ac5 100644 --- a/packages/openapi-to-graphql-cli/README.md +++ b/packages/openapi-to-graphql-cli/README.md @@ -6,9 +6,9 @@ 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 OpenAPI-to-GraphQL as a library, refer to the [`openapi-to-graphql`](https://github.com/strongloop/oasgraph/tree/openapi-to-graphql/packages/openapi-to-graphql) package._ +_Note: To use OpenAPI-to-GraphQL as a library, refer to the [`openapi-to-graphql`](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql) package._ ## Installation @@ -66,9 +66,9 @@ openapi-to-graphql oas.json --save schema.graphql --- -To learn more about the other options, please refer [here](https://github.com/strongloop/oasgraph/tree/openapi-to-graphql/packages/openapi-to-graphql#options). +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/strongloop/oasgraph/tree/openapi-to-graphql/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 diff --git a/packages/openapi-to-graphql-cli/package.json b/packages/openapi-to-graphql-cli/package.json index 8a1a3d8c..d0688114 100644 --- a/packages/openapi-to-graphql-cli/package.json +++ b/packages/openapi-to-graphql-cli/package.json @@ -12,9 +12,9 @@ }, "repository": { "type": "git", - "url": "https://github.com/strongloop/oasgraph/tree/openapi-to-graphql" + "url": "https://github.com/ibm/openapi-to-graphql" }, - "homepage": "https://github.com/strongloop/oasgraph/blob/openapi-to-graphql/README.md", + "homepage": "https://github.com/ibm/openapi-to-graphql", "keywords": [ "ibm", "strongloop", diff --git a/packages/openapi-to-graphql/README.md b/packages/openapi-to-graphql/README.md index f329f86d..1b75fabb 100644 --- a/packages/openapi-to-graphql/README.md +++ b/packages/openapi-to-graphql/README.md @@ -6,9 +6,9 @@ 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 OpenAPI-to-GraphQL via the command line, refer to the [`openapi-to-graphql-cli`](https://github.com/strongloop/oasgraph/tree/openapi-to-graphql/packages/openapi-to-graphql-cli) package._ +_Note: To use OpenAPI-to-GraphQL via the command line, refer to the [`openapi-to-graphql-cli`](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql-cli) package._ ## Installation diff --git a/packages/openapi-to-graphql/package.json b/packages/openapi-to-graphql/package.json index 97408f62..aea4c350 100644 --- a/packages/openapi-to-graphql/package.json +++ b/packages/openapi-to-graphql/package.json @@ -12,9 +12,9 @@ }, "repository": { "type": "git", - "url": "https://github.com/strongloop/oasgraph/tree/openapi-to-graphql" + "url": "https://github.com/ibm/openapi-to-graphql" }, - "homepage": "https://github.com/strongloop/oasgraph/blob/openapi-to-graphql/README.md", + "homepage": "https://github.com/ibm/openapi-to-graphql", "keywords": [ "ibm", "strongloop",