Skip to content

Commit 83a9e0d

Browse files
committed
Add deprecation message
Signed-off-by: Alan Cha <[email protected]>
1 parent fef7438 commit 83a9e0d

File tree

5 files changed

+24
-21
lines changed

5 files changed

+24
-21
lines changed

README.md

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

5+
# Please note: OASGraph has been renamed to [OpenAPI-to-GraphQL](https://github.com/IBM/openapi-to-graphql).
56

67
# OASGraph
78
Translate APIs described by [OpenAPI Specifications (OAS)](https://github.com/OAI/OpenAPI-Specification) into [GraphQL](https://graphql.org/).
89

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

1112

1213
## Getting started
@@ -58,32 +59,32 @@ Here are some guides to further help you get started:
5859
* **Data-centric**
5960
The GraphQL interface is created around the data definitions in the given OAS, not around the endpoints, leading to a natural use of GraphQL.
6061
61-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/master/docs/data-centric.png" alt="Example of data-centric design" width="600">
62+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/data-centric.png" alt="Example of data-centric design" width="600">
6263
6364
* **Nested data**
6465
[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.
6566
66-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/master/docs/links.png" alt="Example of links resolution" width="600">
67+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/links.png" alt="Example of links resolution" width="600">
6768
6869
* **Automatic query resolution**
6970
Automatically generated resolvers translate (nested) GraphQL queries to API requests. Request results are translated back to GraphQL responses.
7071
71-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/master/docs/resolution.png" alt="Example of query resolution" width="600">
72+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/resolution.png" alt="Example of query resolution" width="600">
7273
7374
* **Mutations**
7475
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.
7576
76-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/master/docs/mutations.png" alt="Example of mutation" width="600">
77+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/mutations.png" alt="Example of mutation" width="600">
7778
7879
* **Authentication**
7980
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.
8081
81-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/master/docs/auth.png" alt="Example of authentication" width="600">
82+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/auth.png" alt="Example of authentication" width="600">
8283
8384
* **API Sanitation**
8485
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.
8586
86-
<img src="https://raw.githubusercontent.com/strongloop/oasgraph/master/docs/sanitization.png" alt="Example of sanitation" width="300">
87+
<img src="https://raw.githubusercontent.com/ibm/openapi-to-graphql/master/docs/sanitization.png" alt="Example of sanitation" width="300">
8788
8889
* **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.
8990

packages/oasgraph-cli/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
![Travis (.org)](https://img.shields.io/travis/strongloop/oasgraph.svg?style=flat)
1+
![Travis (.org)](https://img.shields.io/travis/ibm/openapi-to-graphql.svg?style=flat)
22
[![npm](https://img.shields.io/npm/v/oasgraph-cli.svg?style=flat)](https://www.npmjs.com/package/oasgraph-cli)
33
[![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)
44

5+
# 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).
56

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

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

11-
_Note: To use OASGraph as a library, refer to the [`oasgraph`](https://github.com/strongloop/oasgraph/tree/master/packages/oasgraph) package._
12+
_Note: To use OASGraph as a library, refer to the [`oasgraph`](https://github.com/ibm/openapi-to-graphql/tree/oasgraph/packages/oasgraph) package._
1213

1314

1415
## Installation
@@ -61,9 +62,9 @@ oasgraph oas.json --save schema.graphql
6162

6263
***
6364

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

66-
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.
67+
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.
6768

6869

6970
## License

packages/oasgraph-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.git"
15+
"url": "https://github.com/IBM/openapi-to-graphql/tree/oasgraph"
1616
},
17-
"homepage": "https://github.com/strongloop/oasgraph/blob/master/README.md",
17+
"homepage": "https://github.com/IBM/openapi-to-graphql/tree/oasgraph",
1818
"keywords": [
1919
"ibm",
2020
"strongloop",

packages/oasgraph/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
![Travis (.org)](https://img.shields.io/travis/strongloop/oasgraph.svg?style=flat)
1+
![Travis (.org)](https://img.shields.io/travis/ibm/openapi-to-graphql.svg?style=flat)
22
[![npm](https://img.shields.io/npm/v/oasgraph.svg?style=flat)](https://www.npmjs.com/package/oasgraph)
33
[![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)
44

5+
# Please note: OASGraph has been renamed to [OpenAPI-to-GraphQL](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql).
56

67
# OASGraph
78
Generates a [GraphQL schema](https://graphql.org/learn/schema/) for a given [OpenAPI Specification (OAS)](https://github.com/OAI/OpenAPI-Specification).
89

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

11-
_Note: To use OASGraph via the command line, refer to the [`oasgraph-cli`](https://github.com/strongloop/oasgraph/tree/master/packages/oasgraph-cli) package._
12+
_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._
1213

1314

1415
## Installation

packages/oasgraph/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.git"
15+
"url": "https://github.com/IBM/openapi-to-graphql/tree/oasgraph"
1616
},
17-
"homepage": "https://github.com/strongloop/oasgraph/blob/master/README.md",
17+
"homepage": "https://github.com/IBM/openapi-to-graphql/tree/oasgraph",
1818
"keywords": [
1919
"ibm",
2020
"strongloop",

0 commit comments

Comments
 (0)