Skip to content

Commit d547f8b

Browse files
yorekseantleonardAniruddh25
authored
Latest doc updates (#715)
Move mention of the exercise script into the getting-started docs for Azure SQL DB. Co-authored-by: Sean Leonard <[email protected]> Co-authored-by: Aniruddh Munde <[email protected]>
1 parent 298c1ac commit d547f8b

File tree

4 files changed

+18
-24
lines changed

4 files changed

+18
-24
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ With Data API builder, database objects can be exposed via REST or GraphQL endpo
2929

3030
## Limitations
3131

32-
- JWT only supports AAD
33-
- Tables must have a primary key. The primary key must be built on a single column.
34-
- MySQL, MariaDB and PostgreSQL are not yet fully supported.
32+
- JWT only supports Azure AD
33+
- Tables must have a primary key
34+
- MySQL, MariaDB and PostgreSQL are not yet fully supported
3535

3636
## Known Issues
3737

docs/getting-started/getting-started-azure-sql-db.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -299,12 +299,14 @@ that will return all the books written by Isaac Asimov.
299299

300300
Congratulations, you have just created a fully working backend to support your modern applications!
301301

302-
## Deploy on Azure
303-
304-
305-
306-
## Conclusion
307-
308-
WIP
302+
## Exercise
309303

304+
If you want to practice what you have learned, here's a little exercise you can do on your own
310305

306+
- Using the database setup script `/samples/getting-started/azure-sql-db/exercise/exercise.library.azure-sql.sql`:
307+
- add the table `dbo.series` which will store series names (for example: [Foundation Series](https://en.wikipedia.org/wiki/Foundation_series))
308+
- update the `dbo.books` table by adding a column named `series_id`
309+
- update the `dbo.books` table by adding a foreign key constraint on the `dbo.series` table
310+
- Update the configuration file with a new entity named `series`, supported by the `dbo.series` source table you just created.
311+
- Update the `book` entity by creating a relationship with the `series` entity. Make sure you select `one` for the `cardinality` property
312+
- Update the `series` entity by creating a relationship with the `book` entity. Make sure you select `many` for the `cardinality` property

docs/getting-started/getting-started.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -117,14 +117,6 @@ You can use Docker to run the Data API Builder on your machine. Instructions are
117117

118118
Instead of creating the configuration file manually, you can take advantage of the CLI [Getting started with Data API Builder (`dab`) CLI](../getting-started/getting-started-dab-cli.md):
119119

120-
### Exercise
120+
### Deploy on Azure
121121

122-
If you want to practice what you have learned, here's a little exercise you can do on your own
123-
124-
- Use the code `/samples/getting-started/azure-sql-db/exercise/exercise.library.azure-sql.sql` to
125-
- add the `dbo.series` table where to store series names (for example: [Foundation Series](https://en.wikipedia.org/wiki/Foundation_series))
126-
- update the `dbo.books` table to add the `series_id` column
127-
- update the `dbo.books` table to add a foreign key constraint to the `dbo.series` table
128-
- Update the configuration file to add the `series` entity, supported by the `dbo.series` source table
129-
- Update the `book` entity to create a relationship with the `series` entity. Make sure you select `one` for the `cardinality` property
130-
- Update the `series` entity to create a relationship with the `book` entity. Make sure you select `many` for the `cardinality` property
122+
** Work in progress **

docs/readme.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ With Data API builder, database objects can be exposed via REST or GraphQL endpo
1515
- [Running using the CLI tool](./running-using-dab-cli.md)
1616
- [REST features](./rest.md)
1717
- [GraphQL features](./graphql.md)
18-
- [Authentication](./authentication.md) - **Work in progress**
19-
- [Authorization](./authorization.md) - **Work in progress**
20-
- [Relationships](./relationships.md) - **Work in progress**
21-
- [Known Issues and Limitations](/docs/known-issues.md) - **Work in progress**
18+
- [Authentication](./authentication.md) - **Documentation Work in progress**
19+
- [Authorization](./authorization.md) - **Documentation Work in progress**
20+
- [Relationships](./relationships.md) - **Documentation Work in progress**
21+
- [Known Issues and Limitations](/docs/known-issues.md) - **Documentation Work in progress**

0 commit comments

Comments
 (0)