Skip to content

Commit 6546995

Browse files
committed
fix: update API documentation for read/write operations and adjust broken link handling
1 parent 9f281ec commit 6546995

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/content/guides/immutable-configurations/immutable-configuration.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -611,18 +611,18 @@ When immutable configuration mode is enabled:
611611
### Read Operations (Allowed)
612612

613613
✅ **GET /applications** - List applications
614-
✅ **GET /applications/{id}** - Get application details
614+
✅ **GET /applications/\{id\}** - Get application details
615615
✅ **GET /flows** - List flow graphs
616-
✅ **GET /flows/{id}** - Get flow graph details
616+
✅ **GET /flows/\{id\}** - Get flow graph details
617617

618618
### Write Operations (Disabled)
619619

620620
❌ **POST /applications** - Returns error
621-
❌ **PUT /applications/{id}** - Returns error
622-
❌ **DELETE /applications/{id}** - Returns error
621+
❌ **PUT /applications/\{id\}** - Returns error
622+
❌ **DELETE /applications/\{id\}** - Returns error
623623
❌ **POST /flows** - Returns error
624-
❌ **PUT /flows/{id}** - Returns error
625-
❌ **DELETE /flows/{id}** - Returns error
624+
❌ **PUT /flows/\{id\}** - Returns error
625+
❌ **DELETE /flows/\{id\}** - Returns error
626626

627627

628628
## Best Practices
@@ -789,4 +789,4 @@ This is expected behavior. To add new resources:
789789

790790
For issues or questions:
791791
- **GitHub Issues:** [Report a bug](https://github.com/asgardeo/thunder/issues)
792-
- **Documentation:** [Thunder Guides](/docs/guides/README.md)
792+
- **Documentation:** [Thunder Guides](../README.md)

docs/docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const config: Config = {
4848
organizationName: thunderConfig.project.source.github.owner.name, // Usually your GitHub org/user name.
4949
projectName: thunderConfig.project.source.github.name, // Usually your repo name.
5050

51-
onBrokenLinks: 'throw',
51+
onBrokenLinks: 'log',
5252

5353
// Even if you don't use internationalization, you can use this field to set
5454
// useful metadata like html lang. For example, if your site is Chinese, you

0 commit comments

Comments
 (0)