@xano/developer-mcp 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/xanoscript_docs/apis.md +40 -3
package/package.json
CHANGED
package/xanoscript_docs/apis.md
CHANGED
|
@@ -21,17 +21,54 @@ query "<path>" verb=<METHOD> {
|
|
|
21
21
|
### HTTP Methods
|
|
22
22
|
`GET`, `POST`, `PUT`, `PATCH`, `DELETE`
|
|
23
23
|
|
|
24
|
+
### API Groups (Required)
|
|
25
|
+
|
|
26
|
+
Every API endpoint **must** belong to an API group. An API group is a folder within `apis/` that organizes related endpoints together.
|
|
27
|
+
|
|
28
|
+
- API groups appear as top-level folders under `apis/`
|
|
29
|
+
- Each group **must** have an `api_group.xs` file that defines the group
|
|
30
|
+
- The group contains `.xs` files defining individual endpoints
|
|
31
|
+
- The group name becomes part of the endpoint URL path
|
|
32
|
+
- You cannot create endpoints directly in the `apis/` root folder
|
|
33
|
+
|
|
34
|
+
#### Defining an API Group
|
|
35
|
+
|
|
36
|
+
Create an `api_group.xs` file in the group folder:
|
|
37
|
+
|
|
38
|
+
```xs
|
|
39
|
+
api_group "users" {
|
|
40
|
+
description = "User management endpoints"
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### API Group Properties
|
|
45
|
+
|
|
46
|
+
| Property | Description |
|
|
47
|
+
|----------|-------------|
|
|
48
|
+
| `description` | What this API group contains |
|
|
49
|
+
| `canonical` | Optional: custom URL path (overrides folder name) |
|
|
50
|
+
|
|
51
|
+
```xs
|
|
52
|
+
api_group "events" {
|
|
53
|
+
canonical = "events-api" # URL will use /events-api instead of /events
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
24
57
|
### File Structure
|
|
25
58
|
```
|
|
26
59
|
apis/
|
|
27
|
-
├── users/ # API group
|
|
60
|
+
├── users/ # API group folder
|
|
61
|
+
│ ├── api_group.xs # Required: defines the group
|
|
28
62
|
│ ├── list.xs # GET /users
|
|
29
63
|
│ ├── create.xs # POST /users
|
|
30
64
|
│ └── {id}.xs # GET/PATCH/DELETE /users/{id}
|
|
31
|
-
└── products/
|
|
32
|
-
|
|
65
|
+
└── products/ # Another API group
|
|
66
|
+
├── api_group.xs # Required: defines the group
|
|
67
|
+
└── search.xs # GET /products/search
|
|
33
68
|
```
|
|
34
69
|
|
|
70
|
+
> **Note:** Files placed directly in `apis/` without a group folder are invalid. Each API group folder must contain an `api_group.xs` file.
|
|
71
|
+
|
|
35
72
|
---
|
|
36
73
|
|
|
37
74
|
## Basic Structure
|