You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35Lines changed: 35 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -243,6 +243,41 @@ Each package has detailed documentation in its own README:
243
243
244
244
---
245
245
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:
-**[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
+
246
281
## 🤝 Contributing
247
282
248
283
Contributions are welcome! Please feel free to submit a Pull Request.
0 commit comments