Skip to content

Commit 5cf1b1f

Browse files
committed
Test script. Readme updates
1 parent d9d6825 commit 5cf1b1f

File tree

5 files changed

+26
-7
lines changed

5 files changed

+26
-7
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ We are using [Mintlify](https://www.mintlify.com/docs/) to power this documentat
99
To run the documentation locally, run setup once:
1010

1111
```bash
12-
script/setup
12+
$ script/setup
1313
```
1414

1515
Then start the documentation server:
1616

1717
```bash
18-
script/start
18+
$ script/start
1919
✔ Local Mintlify instance is ready. Launching your site...
2020
🌿 Your local preview is available at http://localhost:3000
2121
🌿 Press Ctrl+C any time to stop the local preview.
@@ -29,6 +29,24 @@ Much of the endpoint documentation is auto-generated by Mintlify by reading in t
2929

3030
If you need to update the swagger.json file, please consider saving a copy as swagger.staging.json (for example) and then manually importing the changes you need.
3131

32+
## Testing
33+
34+
Run the local `test` script to check for broken links in the documentation.
35+
36+
```bash
37+
$ script/test
38+
Checking for broken links...
39+
40+
api-reference/v2/stashing/introduction.mdx
41+
/api-reference/v2/tables/post-tables-rows
42+
```
43+
3244
## Publishing
3345

34-
Once changes are made and confirmed in your local environment, you can commit your changes to Github. This will automatically trigger a build of the documentation and deploy to the live environment at: https://glide.mintlify.app/
46+
Once changes are made and confirmed in your local environment, you can commit your changes to Github. This will automatically trigger a build of the documentation and deploy to the live environment at: https://glide.mintlify.app/
47+
48+
## Postman
49+
50+
We use Postman to deliver executable endpoints of the Glide API to the public (in addition to what's available in the documentation). The Postman collection should be kept up to date with the latest endpoints and documentation. Unfortunately, this is a manual process for now.
51+
52+
Please update the Postman collection in the [Glide API v2 public collection](https://www.postman.com/glideapps-internal/workspace/glide/collection/32369785-2375efc0-3be9-43bd-a134-bd430deb4c69?action=share&creator=32369785&active-environment=32369785-f7167028-954c-4563-8b72-365cf2d69b3c) (distinct from the Glide internal Postman collection) with any changes to the API.

api-reference/v2/stashing/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The following endpoints support the use of a stash. Please see the specific endp
4646

4747
* [Create Table](/api-reference/v2/tables/post-tables)
4848
* [Overwrite Table](/api-reference/v2/tables/put-tables)
49-
* [Add Rows to Table](/api-reference/v2/tables/post-tables-rows)
49+
* [Add Rows to Table](/api-reference/v2/tables/post-table-rows)
5050

5151
## Use Cases
5252

api-reference/v2/tutorials/bulk-import.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ To create a table with the data of the stash ID `20240501-import` you can use th
9595

9696
### Add Rows to Table
9797

98-
To add data to an existing table you can use the [add rows to table](/api-reference/v2/tables/post-tables-rows) endpoint with the `stashID` reference of `20240501-import` instead of the actual row values.
98+
To add data to an existing table you can use the [add rows to table](/api-reference/v2/tables/post-table-rows) endpoint with the `stashID` reference of `20240501-import` instead of the actual row values.
9999

100100
```json
101101
{

mint.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
"pages": [
3636
"api-reference/v2/tables/get-tables",
3737
"api-reference/v2/tables/post-tables",
38-
"api-reference/v2/tables/put-tables",
39-
"api-reference/v2/tables/post-table-rows"
38+
"api-reference/v2/tables/post-table-rows",
39+
"api-reference/v2/tables/put-tables"
4040
]
4141
},
4242
{

script/test

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mintlify broken-links

0 commit comments

Comments
 (0)