qiitex v1.0.0 Qiitex.Api.Template

記事のひな形に利用できるテンプレートを表します。Qiita:Teamでのみ有効です。

Link to this section Summary

Functions

新しくテンプレートを作成します。

テンプレートを削除します。

テンプレートを取得します。

チーム内のテンプレート一覧を返します。

テンプレートを更新します。

Link to this section Functions

Link to this function

create_template(client, params)

新しくテンプレートを作成します。

POST /api/v2/templates

  • body

    • テンプレートの本文
    • example: Weekly MTG on %{Year}/%{month}/%{day}
    • type: string
  • name

    • テンプレートを判別するための名前
    • example: Weekly MTG
    • type: string
  • tags

    • タグ一覧
    • example: [{"versions":["0.0.1"],"name":"MTG/%{Year}/%{month}/%{day}"}]
    • type: array
  • title

    • 生成される記事のタイトルの雛形
    • example: Weekly MTG on %{Year}/%{month}/%{day}
    • type: string
Link to this function

delete_template(client, template_id)

テンプレートを削除します。

DELETE /api/v2/templates/:template_id

Link to this function

get_template(client, template_id)

テンプレートを取得します。

GET /api/v2/templates/:template_id

Link to this function

list_templates(client, options \\ %{})

チーム内のテンプレート一覧を返します。

GET /api/v2/templates

  • page optional

    • ページ番号 (1から100まで)
    • example: 1
    • pattern: ^[0-9]+$
    • type: string
  • per_page optional

    • 1ページあたりに含まれる要素数 (1から100まで)
    • example: 20
    • pattern: ^[0-9]+$
    • type: string
Link to this function

update_template(client, template_id, params)

テンプレートを更新します。

PATCH /api/v2/templates/:template_id

  • body

    • テンプレートの本文
    • example: Weekly MTG on %{Year}/%{month}/%{day}
    • type: string
  • name

    • テンプレートを判別するための名前
    • example: Weekly MTG
    • type: string
  • tags

    • タグ一覧
    • example: [{"versions":["0.0.1"],"name":"MTG/%{Year}/%{month}/%{day}"}]
    • type: array
  • title

    • 生成される記事のタイトルの雛形
    • example: Weekly MTG on %{Year}/%{month}/%{day}
    • type: string