๋ฌธ์ id๋ฅผ ํค๋ก ํ๋ ์ปค์คํ ์ปดํฌ๋ํธ์ ๋ฌธ์ ๋ณํ์ ์ ์ํธํฉ๋๋ค.
๋ฌธ์ id๋ฅผ ํค๋ก ํ๋ ์ปค์คํ
์ปดํฌ๋ํธ์ ๋ณํ( documents ํ)์ ์
์ํธํฉ๋๋ค. ๊ธฐ์กด ๋ณํ์ ์
๋ฐ์ดํธํ๋ ค๋ฉด id๋ฅผ ์ ๊ณตํ๊ณ , ์ ๋ณํ์ ์ฝ์
ํ๋ ค๋ฉด ์๋ตํ์ธ์. /schemas/{schema_name}์์๋ ์ฌ์ฉํ ์ ์์ต๋๋ค. ์ฝํ
์ธ ๋ ์ปดํฌ๋ํธ์ ์คํค๋ง์ ๋ฐ๋ผ ๊ฒ์ฆ๋ฉ๋๋ค.
์ธ์ฆ: API ํค โ ํญ์ ํ์ํ๋ฉฐ, ํค์๋ content_write ๊ถํ์ด ํฌํจ๋์ด์ผ ํฉ๋๋ค.
| ๋งค๊ฐ๋ณ์ | ์ ํ | ํ์ | ๋น๊ณ |
|---|---|---|---|
schema_name | ๋ฌธ์์ด | ์ | ์ปค์คํ ์ปดํฌ๋ํธ ์ด๋ฆ์ ๋๋ค. |
| ๋งค๊ฐ๋ณ์ | ์ ํ | ํ์ | ๋น๊ณ |
|---|---|---|---|
websiteId | uuid | ์๋์ | ๋์ ์น์ฌ์ดํธ์
๋๋ค; ๊ธฐ๋ณธ์ ์ผ๋ก Host ํค๋/๊ตฌ์ฑ์ผ๋ก ๋์ฒด๋ฉ๋๋ค. |
api_key | ๋ฌธ์์ด | ์๋์ | x-api-key ํค๋์ ๋์์
๋๋ค. |
{
"id": "<uuid>",
"title": "๋ด ๋ณํ",
"content": { "title": "์๋
ํ์ธ์", "body": "..." }
}
| ํ๋ | ์ ํ | ํ์ | ๋น๊ณ |
|---|---|---|---|
id | uuid | ์๋์ | ์กด์ฌํ ๊ฒฝ์ฐ ์ผ์นํ๋ ๋ณํ์ ์ ๋ฐ์ดํธํ๊ณ , ์๊ฑฐ๋ ์ฐพ์ ์ ์๋ ๊ฒฝ์ฐ ์ฝ์ ํฉ๋๋ค. |
title | ๋ฌธ์์ด | ์๋์ | ํ์ ์ ๋ชฉ์
๋๋ค. ์ฝ์
์ ๊ธฐ๋ณธ๊ฐ์ "Untitled"์ด๋ฉฐ, ์
๋ฐ์ดํธ ์ ์๋ตํ๋ฉด ๋ณ๊ฒฝ๋์ง ์์ต๋๋ค. |
content | ๊ฐ์ฒด | ์ | ์ปดํฌ๋ํธ์ ์คํค๋ง์ ๋ฐ๋ผ ๊ฒ์ฆ๋๋ ํ๋ ๊ฐ์ ๋๋ค. JSON ๊ฐ์ฒด์ฌ์ผ ํฉ๋๋ค. |
{
"id": "...",
"schema_name": "๊ฒ์๋ฌผ",
"title": "๋ด ๋ณํ",
"status": "์ด์",
"version": 2,
"created": true
}
created๋ ์ฝ์
์(HTTP 201) true์ด๊ณ , ์
๋ฐ์ดํธ ์(HTTP 200) false์
๋๋ค.
curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
-H 'x-api-key: <key>' \
-H 'Content-Type: application/json' \
-d '{"content":{"title":"์๋
ํ์ธ์"}}'
400 โ ์๋ชป๋ websiteId, ๊ฐ์ฒด๊ฐ ์๋ content, ์ ์ ์๊ฑฐ๋ ๋ณด๊ด๋ ์ปดํฌ๋ํธ, ๋๋ ๊ฒ์ฆ ์คํจ401 โ ๋๋ฝ๋์๊ฑฐ๋ ์๋ชป๋ API ํค403 โ ํค์ content_write ๊ถํ์ด ์์ต๋๋ค404 โ id๊ฐ ์ ๊ณต๋์์ผ๋ ์ผ์นํ๋ ๋ณํ์ด ์์