Skip to content

Commit 8a31741

Browse files
committed
docs(examples): add proper links for old versions and warning note
1 parent f3bca23 commit 8a31741

3 files changed

Lines changed: 39 additions & 32 deletions

File tree

examples/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ This folder consist of simple examples showing how to use different `TypeGraphQL
44

55
All examples has a `examples.gql` file with sample queries/mutations/subscriptions that you can execute.
66

7+
> **Note**: Be aware that the examples on master branch are designed to work with latest codebase that might not be released yet.
8+
So if you are looking for examples that are compatible with the version you use, just browse the files by the git tag, e.g. [`tree/v0.16.0` for `0.16.0` release](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples).
9+
710
## Basics
811

912
- [Simple usage of fields, basic types and resolvers](./simple-usage)

website/versioned_docs/version-0.16.0/examples.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,31 @@ On the [GitHub repository](https://github.com/19majkel94/type-graphql) there are
1010
All examples has a `examples.gql` file with sample queries/mutations/subscriptions that you can execute.
1111

1212
## Basics
13-
- [Simple usage of fields, basic types and resolvers](https://github.com/19majkel94/type-graphql/tree/master/examples/simple-usage)
13+
14+
- [Simple usage of fields, basic types and resolvers](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/simple-usage)
1415

1516
## Advanced
16-
- [Enums and unions](https://github.com/19majkel94/type-graphql/tree/master/examples/enums-and-unions)
17-
- [Interfaces and types inheritance](https://github.com/19majkel94/type-graphql/tree/master/examples/interfaces-inheritance)
18-
- [Subscriptions (simple)](https://github.com/19majkel94/type-graphql/tree/master/examples/simple-subscriptions)
19-
- [Subscriptions (using Redis)](https://github.com/19majkel94/type-graphql/tree/master/examples/redis-subscriptions)
20-
- [Resolvers inheritance](https://github.com/19majkel94/type-graphql/tree/master/examples/resolvers-inheritance)
17+
18+
- [Enums and unions](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/enums-and-unions)
19+
- [Interfaces and types inheritance](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/interfaces-inheritance)
20+
- [Subscriptions (simple)](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/simple-subscriptions)
21+
- [Subscriptions (using Redis)](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/redis-subscriptions)
22+
- [Resolvers inheritance](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/resolvers-inheritance)
2123

2224
## Features usage
23-
- [Dependency injection (IoC container)](https://github.com/19majkel94/type-graphql/tree/master/examples/using-container)
24-
- [scoped container](https://github.com/19majkel94/type-graphql/tree/master/examples/using-scoped-container)
25-
- [Authorization](https://github.com/19majkel94/type-graphql/tree/master/examples/authorization)
26-
- [Validation](https://github.com/19majkel94/type-graphql/tree/master/examples/automatic-validation)
27-
- [Middlewares](https://github.com/19majkel94/type-graphql/tree/master/examples/middlewares)
25+
26+
- [Dependency injection (IoC container)](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/using-container)
27+
- [scoped container](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/using-scoped-container)
28+
- [Authorization](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/authorization)
29+
- [Validation](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/automatic-validation)
30+
- [Middlewares](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/middlewares)
2831

2932
## 3rd party libs integration
30-
- [TypeORM (manual, synchronous) *](https://github.com/19majkel94/type-graphql/tree/master/examples/typeorm-basic-usage)
31-
- [TypeORM (automatic, lazy relations) *](https://github.com/19majkel94/type-graphql/tree/master/examples/typeorm-lazy-relations)
32-
- [Apollo Engine (Apollo Cache Control) **](https://github.com/19majkel94/type-graphql/tree/master/examples/apollo-engine)
3333

34-
_* Note that you need to edit the TypeORM examples `index.ts` with credentials to your local database_
34+
- [TypeORM (manual, synchronous) \*](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/typeorm-basic-usage)
35+
- [TypeORM (automatic, lazy relations) \*](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/typeorm-lazy-relations)
36+
- [Apollo Engine (Apollo Cache Control) \*\*](https://github.com/19majkel94/type-graphql/tree/v0.16.0/examples/apollo-engine)
37+
38+
_\* Note that you need to edit the TypeORM examples `index.ts` with credentials to your local database_
3539

36-
_** Note that you need to provide `APOLLO_ENGINE_API_KEY` env variable with your own API key_
40+
_\*\* Note that you need to provide `APOLLO_ENGINE_API_KEY` env variable with your own API key_

website/versioned_docs/version-0.17.0/examples.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,31 @@ All examples has a `examples.gql` file with sample queries/mutations/subscriptio
1111

1212
## Basics
1313

14-
- [Simple usage of fields, basic types and resolvers](https://github.com/19majkel94/type-graphql/tree/master/examples/simple-usage)
14+
- [Simple usage of fields, basic types and resolvers](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/simple-usage)
1515

1616
## Advanced
1717

18-
- [Enums and unions](https://github.com/19majkel94/type-graphql/tree/master/examples/enums-and-unions)
19-
- [Subscriptions (simple)](https://github.com/19majkel94/type-graphql/tree/master/examples/simple-subscriptions)
20-
- [Subscriptions (using Redis)](https://github.com/19majkel94/type-graphql/tree/master/examples/redis-subscriptions)
21-
- [Interfaces](https://github.com/19majkel94/type-graphql/tree/master/examples/interfaces-inheritance)
18+
- [Enums and unions](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/enums-and-unions)
19+
- [Subscriptions (simple)](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/simple-subscriptions)
20+
- [Subscriptions (using Redis)](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/redis-subscriptions)
21+
- [Interfaces](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/interfaces-inheritance)
2222

2323
## Features usage
2424

25-
- [Dependency injection (IoC container)](https://github.com/19majkel94/type-graphql/tree/master/examples/using-container)
26-
- [scoped container](https://github.com/19majkel94/type-graphql/tree/master/examples/using-scoped-container)
27-
- [Authorization](https://github.com/19majkel94/type-graphql/tree/master/examples/authorization)
28-
- [Validation](https://github.com/19majkel94/type-graphql/tree/master/examples/automatic-validation)
29-
- [Types inheritance](https://github.com/19majkel94/type-graphql/tree/master/examples/interfaces-inheritance)
30-
- [Resolvers inheritance](https://github.com/19majkel94/type-graphql/tree/master/examples/resolvers-inheritance)
31-
- [Generic types](https://github.com/19majkel94/type-graphql/tree/master/examples/generic-types)
32-
- [Middlewares](https://github.com/19majkel94/type-graphql/tree/master/examples/middlewares)
25+
- [Dependency injection (IoC container)](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/using-container)
26+
- [scoped container](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/using-scoped-container)
27+
- [Authorization](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/authorization)
28+
- [Validation](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/automatic-validation)
29+
- [Types inheritance](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/interfaces-inheritance)
30+
- [Resolvers inheritance](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/resolvers-inheritance)
31+
- [Generic types](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/generic-types)
32+
- [Middlewares](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/middlewares)
3333

3434
## 3rd party libs integration
3535

36-
- [TypeORM (manual, synchronous) \*](https://github.com/19majkel94/type-graphql/tree/master/examples/typeorm-basic-usage)
37-
- [TypeORM (automatic, lazy relations) \*](https://github.com/19majkel94/type-graphql/tree/master/examples/typeorm-lazy-relations)
38-
- [Apollo Engine (Apollo Cache Control) \*\*](https://github.com/19majkel94/type-graphql/tree/master/examples/apollo-engine)
36+
- [TypeORM (manual, synchronous) \*](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/typeorm-basic-usage)
37+
- [TypeORM (automatic, lazy relations) \*](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/typeorm-lazy-relations)
38+
- [Apollo Engine (Apollo Cache Control) \*\*](https://github.com/19majkel94/type-graphql/tree/v0.17.0/examples/apollo-engine)
3939

4040
_\* Note that you need to edit the TypeORM examples `index.ts` with credentials to your local database_
4141

0 commit comments

Comments
 (0)