Skip to content

Commit 5e279ff

Browse files
committed
docs(json-api-server-e2e): add examples and usage documentation for JSON:API, JSON-RPC, and ACL tests
1 parent 74b3aae commit 5e279ff

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,41 @@ Each package has detailed documentation in its own README:
243243

244244
---
245245

246+
## 📘 Examples & Usage
247+
248+
For detailed usage examples and real-world scenarios, refer to the comprehensive **E2E test suites**. These tests serve as living documentation and demonstrate best practices:
249+
250+
### JSON:API SDK Examples
251+
Learn how to use the JSON:API client SDK with various operations:
252+
253+
- **[GET Operations](apps/json-api-server-e2e/src/json-api/json-api-sdk/get-method.spec.ts)** – Fetching resources, filtering, pagination, sparse fieldsets, and relationships
254+
- **[POST Operations](apps/json-api-server-e2e/src/json-api/json-api-sdk/post-method.spec.ts)** – Creating resources with relationships
255+
- **[PATCH Operations](apps/json-api-server-e2e/src/json-api/json-api-sdk/patch-methode.spec.ts)** – Updating resources and relationships
256+
- **[Atomic Operations](apps/json-api-server-e2e/src/json-api/json-api-sdk/atomic-sdk.spec.ts)** – Batch requests with multiple operations
257+
- **[Advanced Configuration](apps/json-api-server-e2e/src/json-api/json-api-sdk/check-othe-call.spec.ts)** – Custom routes, UUID IDs, validation pipes
258+
- **[Common Decorators](apps/json-api-server-e2e/src/json-api/json-api-sdk/check-common-decorator.spec.ts)** – Guards, interceptors, and exception filters
259+
260+
### JSON-RPC Examples
261+
Explore JSON-RPC 2.0 client usage patterns:
262+
263+
- **[HTTP Transport](apps/json-api-server-e2e/src/json-api/json-rpc/run-json-rpc.spec.ts)** – Single and batch RPC calls over HTTP, error handling
264+
- **[WebSocket Transport](apps/json-api-server-e2e/src/json-api/json-rpc/run-ws-json-rpc.spec.ts)** – Real-time RPC over WebSocket connections
265+
266+
### Access Control (ACL) Examples
267+
Understand fine-grained permission enforcement with CASL integration:
268+
269+
- **[GET All Resources](apps/json-api-server-e2e/src/json-api/json-acl/1-get-all-acl-check.spec.ts)** – Field-level and row-level filtering
270+
- **[GET One Resource](apps/json-api-server-e2e/src/json-api/json-acl/2-get-one-acl-check.spec.ts)** – Resource-level access control
271+
- **[GET Relationships](apps/json-api-server-e2e/src/json-api/json-acl/3-get-relationship-acl-check.spec.ts)** – Relationship endpoint permissions
272+
- **[PATCH Operations](apps/json-api-server-e2e/src/json-api/json-acl/4-patch-one-acl-check.spec.ts)** – Update permissions with field and value restrictions
273+
- **[POST Operations](apps/json-api-server-e2e/src/json-api/json-acl/5-post-one-acl-check.spec.ts)** – Create permissions with conditional validation
274+
- **[DELETE Operations](apps/json-api-server-e2e/src/json-api/json-acl/6-delete-one-acl-check.spec.ts)** – Conditional delete based on resource state
275+
- **[Atomic Operations ACL](apps/json-api-server-e2e/src/json-api/json-acl/10-atomic-operation.spec.ts)** – ACL enforcement across batch requests
276+
277+
Each test file includes detailed JSDoc comments explaining the scenarios, ACL rules, and expected behavior.
278+
279+
---
280+
246281
## 🤝 Contributing
247282

248283
Contributions are welcome! Please feel free to submit a Pull Request.

0 commit comments

Comments
 (0)