Skip to content

Commit e8cc3c6

Browse files
committed
docs: Clarify mutual exclusivity of isDraft and isClosed in README
1 parent 757a327 commit e8cc3c6

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,8 @@ client
348348

349349
By specifying the `isClosed` property, the content can be registered as archived.
350350

351+
> **Note:** `isDraft` and `isClosed` are mutually exclusive. Do not pass both as `true`; the SDK rejects that combination at runtime with an error. When using `isClosed: true`, omit `isDraft` or set it to `false` (the default).
352+
351353
```javascript
352354
client
353355
.create({
@@ -364,7 +366,7 @@ client
364366

365367
#### Create closed content with specified ID
366368

367-
By specifying the `contentId` and `isClosed` properties, the content can be registered as archived with a specified ID.
369+
By specifying the `contentId` and `isClosed` properties, the content can be registered as archived with a specified ID. The same rule applies as above: `isDraft` and `isClosed` cannot both be `true`.
368370

369371
```javascript
370372
client

README_jp.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,8 @@ client
348348

349349
`isClosed`プロパティを使用することで、公開終了のステータスでコンテンツを登録できます。
350350

351+
> **注:** `isDraft``isClosed` は同時に `true` にできません。両方を `true` で渡すと、SDK はランタイムでエラーとして拒否します。`isClosed: true` を使う場合は、`isDraft` を省略、または `false` を設定してください。
352+
351353
```javascript
352354
client
353355
.create({
@@ -364,7 +366,7 @@ client
364366

365367
#### 指定されたIDかつ公開終了のステータスでコンテンツを登録
366368

367-
`contentId`プロパティと`isClosed`プロパティを使用することで、指定されたIDかつ公開終了のステータスでコンテンツを登録できます。
369+
`contentId`プロパティと`isClosed`プロパティを使用することで、指定されたIDかつ公開終了のステータスでコンテンツを登録できます。上記と同様、`isDraft``isClosed` を同時に `true` にすることはできません。
368370

369371
```javascript
370372
client

0 commit comments

Comments
 (0)