使用说明

这份示例可同时用于预检和发布。根据用户内容修改 note，外观与可见性按需设置。

{
  "schemaVersion": 1,
  "note": {
    "title": "本周进展",
    "cues": [
      {
        "keyword": "下一步",
        "note": "邀请同事试用"
      }
    ],
    "sections": [
      {
        "heading": "已完成",
        "content": "完成了笔记发布接口。",
        "highlights": [
          "发布接口"
        ]
      }
    ],
    "summary": "准备收集第一轮试用反馈。",
    "doodleTheme": "book"
  },
  "appearance": {
    "layout": "hybrid-cornell",
    "overflow": "expand"
  },
  "visibility": "unlisted"
}

先在环境中设置 INKSCRIBE_API_KEY 和 INKSCRIBE_IDEMPOTENCY_KEY。新作品使用新的幂等键；重试同一作品时保留原键。下面的命令会先预检，只有预检成功才会发布。

(
  set -eu
  : "${INKSCRIBE_API_KEY:?Set INKSCRIBE_API_KEY first}"
  : "${INKSCRIBE_IDEMPOTENCY_KEY:?Set a key for this publication}"
  INKSCRIBE_BASE_URL='https://scribe.orangely.xyz'
  payload=$(cat <<'JSON'
{
  "schemaVersion": 1,
  "note": {
    "title": "本周进展",
    "cues": [
      {
        "keyword": "下一步",
        "note": "邀请同事试用"
      }
    ],
    "sections": [
      {
        "heading": "已完成",
        "content": "完成了笔记发布接口。",
        "highlights": [
          "发布接口"
        ]
      }
    ],
    "summary": "准备收集第一轮试用反馈。",
    "doodleTheme": "book"
  },
  "appearance": {
    "layout": "hybrid-cornell",
    "overflow": "expand"
  },
  "visibility": "unlisted"
}
JSON
  )

  curl --fail-with-body --silent --show-error \
    -X POST "$INKSCRIBE_BASE_URL/api/v1/notes/validate" \
    -H "Authorization: Bearer $INKSCRIBE_API_KEY" \
    -H "Content-Type: application/json" \
    --data-binary "$payload"

  curl --fail-with-body --silent --show-error \
    -X POST "$INKSCRIBE_BASE_URL/api/v1/notes" \
    -H "Authorization: Bearer $INKSCRIBE_API_KEY" \
    -H "Content-Type: application/json" \
    -H "Idempotency-Key: $INKSCRIBE_IDEMPOTENCY_KEY" \
    --data-binary "$payload"
)