Skip to content

Commit c2f51da

Browse files
Alan-ChaErikWittern
authored andcommitted
Fix links
Signed-off-by: Alan Cha <[email protected]>
1 parent 4f1e88d commit c2f51da

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
![GitHub last commit](https://img.shields.io/github/last-commit/strongloop/oasgraph.svg?style=flat)
1+
![GitHub last commit](https://img.shields.io/github/last-commit/ibm/openapi-to-graphql.svg?style=flat)
22
![Travis (.org)](https://img.shields.io/travis/ibm/openapi-to-graphql.svg?style=flat)
33
[![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)
44

55
# OpenAPI-to-GraphQL
66

77
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/).
88

9-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/openapi-to-graphql/docs/translation.png" alt="Overview of translation" width="600">
9+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/translation.png" alt="Overview of translation" width="600">
1010

1111
## Getting started
1212

@@ -57,32 +57,32 @@ Here are some guides to further help you get started:
5757
- **Data-centric**
5858
The GraphQL interface is created around the data definitions in the given OAS, not around the endpoints, leading to a natural use of GraphQL.
5959

60-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/openapi-to-graphql/docs/data-centric.png" alt="Example of data-centric design" width="600">
60+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/data-centric.png" alt="Example of data-centric design" width="600">
6161

6262
- **Nested data**
6363
[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.
6464

65-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/openapi-to-graphql/docs/links.png" alt="Example of links resolution" width="600">
65+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/links.png" alt="Example of links resolution" width="600">
6666

6767
- **Automatic query resolution**
6868
Automatically generated resolvers translate (nested) GraphQL queries to API requests. Request results are translated back to GraphQL responses.
6969

70-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/openapi-to-graphql/docs/resolution.png" alt="Example of query resolution" width="600">
70+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/resolution.png" alt="Example of query resolution" width="600">
7171

7272
- **Mutations**
7373
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.
7474

75-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/openapi-to-graphql/docs/mutations.png" alt="Example of mutation" width="600">
75+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/mutations.png" alt="Example of mutation" width="600">
7676

7777
- **Authentication**
7878
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.
7979

80-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/openapi-to-graphql/docs/auth.png" alt="Example of authentication" width="600">
80+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/auth.png" alt="Example of authentication" width="600">
8181

8282
- **API Sanitation**
8383
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.
8484

85-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/openapi-to-graphql/docs/sanitization.png" alt="Example of sanitation" width="300">
85+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/sanitization.png" alt="Example of sanitation" width="300">
8686

8787
- **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.
8888

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
Command line interface (CLI) for turning APIs described by [OpenAPI Specification (OAS)](https://github.com/OAI/OpenAPI-Specification) into [GraphQL](https://graphql.org/) interfaces.
88

9-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/openapi-to-graphql/docs/translation.png" alt="Overview of translation" width="600">
9+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/translation.png" alt="Overview of translation" width="600">
1010

11-
_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._
11+
_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._
1212

1313
## Installation
1414

@@ -66,9 +66,9 @@ openapi-to-graphql oas.json --save schema.graphql
6666

6767
---
6868

69-
To learn more about the other options, please refer [here](https://github.com/strongloop/oasgraph/tree/openapi-to-graphql/packages/openapi-to-graphql#options).
69+
To learn more about the other options, please refer [here](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql#options).
7070

71-
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.
71+
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.
7272

7373
## License
7474

packages/openapi-to-graphql-cli/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
},
1313
"repository": {
1414
"type": "git",
15-
"url": "https://github.com/strongloop/oasgraph/tree/openapi-to-graphql"
15+
"url": "https://github.com/ibm/openapi-to-graphql"
1616
},
17-
"homepage": "https://github.com/strongloop/oasgraph/blob/openapi-to-graphql/README.md",
17+
"homepage": "https://github.com/ibm/openapi-to-graphql",
1818
"keywords": [
1919
"ibm",
2020
"strongloop",

packages/openapi-to-graphql/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
Generates a [GraphQL schema](https://graphql.org/learn/schema/) for a given [OpenAPI Specification (OAS)](https://github.com/OAI/OpenAPI-Specification).
88

9-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/openapi-to-graphql/docs/translation.png" alt="Overview of translation" width="600">
9+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/translation.png" alt="Overview of translation" width="600">
1010

11-
_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._
11+
_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._
1212

1313
## Installation
1414

packages/openapi-to-graphql/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
},
1313
"repository": {
1414
"type": "git",
15-
"url": "https://github.com/strongloop/oasgraph/tree/openapi-to-graphql"
15+
"url": "https://github.com/ibm/openapi-to-graphql"
1616
},
17-
"homepage": "https://github.com/strongloop/oasgraph/blob/openapi-to-graphql/README.md",
17+
"homepage": "https://github.com/ibm/openapi-to-graphql",
1818
"keywords": [
1919
"ibm",
2020
"strongloop",

0 commit comments

Comments
 (0)