paku/microcms-lisp-sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use the plural form for list endpoints

Browse source
This commit is contained in:
Akira Tempaku 2025-04-21 09:22:24 +09:00
parent d72bafbad7
commit 6736b3cd60
Signed by: paku
GPG key ID: 5B4E8402BCC50607
1 changed files with 6 additions and 6 deletions

12
README.md
View file

@ -21,17 +21,17 @@ Use `define-list-client` macro to define functions for list-type content.
The JSON response from the microCMS API are automatically converted into plist, with keys transformed from camelCase to kebab-case. The JSON response from the microCMS API are automatically converted into plist, with keys transformed from camelCase to kebab-case.
```lisp ```lisp
(microcms:define-list-client article) (microcms:define-list-client articles)
``` ```
This will generate the following functions: This will generate the following functions:
| Function Name | Arguments | Description | | Function Name | Arguments | Description |
|---------------|-----------|-------------| |---------------|-----------|-------------|
| `get-article-list` | (&key `query`) | Get a list of articles. | | `get-articles-list` | (&key `query`) | Get a list of articles. |
| `get-article-detail` | (`id`, &key `query`) | Get details of a specific article by ID. | | `get-articles-detail` | (`id`, &key `query`) | Get details of a specific article by ID. |
| `create-article` | (`content`, &key `query`) | Create a new article with the given content. | | `create-articles` | (`content`, &key `query`) | Create a new article with the given content. |
| `update-article` | (`id`, `content`) | Update an existing article by its ID with new content. | | `update-articles` | (`id`, `content`) | Update an existing article by its ID with new content. |
| `delete-article` | (`id`) | Delete an article by its ID. | | `delete-articles` | (`id`) | Delete an article by its ID. |
### Object Type Endpoint ### Object Type Endpoint