Skip to content

Commit 6736b3c

Browse files
committed
Use the plural form for list endpoints
1 parent d72bafb commit 6736b3c

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,17 @@ Use `define-list-client` macro to define functions for list-type content.
2121
The JSON response from the microCMS API are automatically converted into plist, with keys transformed from camelCase to kebab-case.
2222

2323
```lisp
24-
(microcms:define-list-client article)
24+
(microcms:define-list-client articles)
2525
```
2626
This will generate the following functions:
2727

2828
| Function Name | Arguments | Description |
2929
|---------------|-----------|-------------|
30-
| `get-article-list` | (&key `query`) | Get a list of articles. |
31-
| `get-article-detail` | (`id`, &key `query`) | Get details of a specific article by ID. |
32-
| `create-article` | (`content`, &key `query`) | Create a new article with the given content. |
33-
| `update-article` | (`id`, `content`) | Update an existing article by its ID with new content. |
34-
| `delete-article` | (`id`) | Delete an article by its ID. |
30+
| `get-articles-list` | (&key `query`) | Get a list of articles. |
31+
| `get-articles-detail` | (`id`, &key `query`) | Get details of a specific article by ID. |
32+
| `create-articles` | (`content`, &key `query`) | Create a new article with the given content. |
33+
| `update-articles` | (`id`, `content`) | Update an existing article by its ID with new content. |
34+
| `delete-articles` | (`id`) | Delete an article by its ID. |
3535

3636
### Object Type Endpoint
3737

0 commit comments

Comments
 (0)