qiitex v1.0.0 Qiitex.Api.Project

Qiita:Team上でのプロジェクトを表します。Qiita:Teamでのみ有効です。

Link to this section Summary

Functions

プロジェクトを新たに作成します。

プロジェクトを削除します。

プロジェクトを返します。

ユーザー名を指定してプロジェクトを新たに作成します。

チーム内に存在するプロジェクト一覧をプロジェクト作成日時の降順で返します。

プロジェクトを更新します。

Link to this section Functions

Link to this function

create_project(client, params)

プロジェクトを新たに作成します。

POST /api/v2/projects

  • archived optional

    • このプロジェクトが進行中かどうか
    • example: false
    • type: boolean
  • body

    • Markdown形式の本文
    • example: # Example
    • type: string
  • name

    • プロジェクト名
    • example: Kobiro Project
    • type: string
  • tags optional

    • 記事に付いたタグ一覧
    • example: [{"versions":["0.0.1"],"name":"Ruby"}]
    • type: array
Link to this function

delete_project(client, project_id)

プロジェクトを削除します。

DELETE /api/v2/projects/:project_id

Link to this function

get_project(client, project_id)

プロジェクトを返します。

GET /api/v2/projects/:project_id

Link to this function

import_project(client, params)

ユーザー名を指定してプロジェクトを新たに作成します。

POST /api/v2/imported_projects

  • archived optional

    • このプロジェクトが進行中かどうか
    • example: false
    • type: boolean
  • body

    • Markdown形式の本文
    • example: # Example
    • type: string
  • created_at optional

    • データが作成された日時
    • example: 2000-01-01T00:00:00+00:00
    • format: date-time
    • type: string
  • name

    • プロジェクト名
    • example: Kobiro Project
    • type: string
  • tags optional

    • 記事に付いたタグ一覧
    • example: [{"versions":["0.0.1"],"name":"Ruby"}]
    • type: array
  • updated_at optional

    • データが最後に更新された日時
    • example: 2000-01-01T00:00:00+00:00
    • format: date-time
    • type: string
  • user_id

    • ユーザID
    • example: yaotti
    • type: string
Link to this function

list_projects(client, options \\ %{})

チーム内に存在するプロジェクト一覧をプロジェクト作成日時の降順で返します。

GET /api/v2/projects

  • 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_project(client, project_id, params)

プロジェクトを更新します。

PATCH /api/v2/projects/:project_id

  • archived optional

    • このプロジェクトが進行中かどうか
    • example: false
    • type: boolean
  • body

    • Markdown形式の本文
    • example: # Example
    • type: string
  • name

    • プロジェクト名
    • example: Kobiro Project
    • type: string
  • tags optional

    • 記事に付いたタグ一覧
    • example: [{"versions":["0.0.1"],"name":"Ruby"}]
    • type: array