docs: improvements and fixes to API route docs (#9197)

General improvements and fixes to docs around API routes
This commit is contained in:
Shahed Nasser
2024-09-19 14:08:23 +00:00
committed by GitHub
parent 270a9a1770
commit bf4335f2a6
11 changed files with 240 additions and 66 deletions
@@ -10,7 +10,7 @@ In this chapter, you'll learn what a searchable property is and how to define it
Methods generated by the [service factory](../../modules/service-factory/page.mdx) that accept filters, such as `list{ModelName}s`, accept a `q` property as part of the filters.
When the `q` filter is passed, the query is applied on searchable properties in a data model.
When the `q` filter is passed, the data model's searchable properties are queried to find matching records.
---
@@ -47,4 +47,4 @@ const myCustoms = await helloModuleService.listMyCustoms({
})
```
The `q` filter is applied on the `name` property of the `MyCustom` records.
This retrieves records that include `John` in their `name` property.