機械翻訳について

移動先

• リクエスト
• レスポンス

プロジェクトの更新

put

/api/v2/projects/{id}/

このリソースに対してPUTまたはPATCHリクエストを行って、このプロジェクトを更新します。 次のフィールドを変更できます。

• name: このプロジェクトの名前。(文字列、必須)
• description: このプロジェクトのオプションの説明。(文字列、デフォルト="")
• local_path: このプロジェクトのプレイブックおよび関連ファイルを含む(PROJECTS_ROOTに対して相対的な)ローカル・パス。(文字列、デフォルト="")
• scm_type: プロジェクトを格納するために使用するソース・コントロール・システムを指定します。(選択)
  • "": 手動(デフォルト)
  • git: Git
  • hg: Mercurial
  • svn: Subversion
  • insights: Red Hat Insights
  • archive: リモート・アーカイブ
• scm_url: プロジェクトが格納される場所。(文字列、デフォルト="")
• scm_branch: チェックアウトする特定のブランチ、タグまたはコミット。(文字列、デフォルト="")
• scm_refspec: gitプロジェクトについて、フェッチする追加のrefspec。(文字列、デフォルト="")
• scm_clean: プロジェクトを同期化する前にローカルの変更を破棄します。(ブール、デフォルト=False)
• scm_delete_on_update: 同期化する前にプロジェクトを削除します。(ブール、デフォルト=False)
• credential: (id、デフォルト=``)

• timeout: タスクが取り消されるまでの実行時間(秒)。(整数、デフォルト=0)

• organization: このテンプレートへのアクセス権を決定するために使用される組織。(id、デフォルト=``)

• scm_update_on_launch: プロジェクトを使用するジョブが起動されたときにプロジェクトを更新します。(ブール、デフォルト=False)
• scm_update_cache_timeout: 最後のプロジェクト更新が実行された何秒後に、新しいプロジェクト更新がジョブの依存関係として起動されるか。(整数、デフォルト=0)
• allow_override: このプロジェクトを使用するジョブ・テンプレートでSCMブランチまたはリビジョンの変更を許可します。(ブール、デフォルト=False)
• custom_virtualenv: 使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス(文字列、デフォルト="")

PUTリクエストの場合は、リクエストにすべてのフィールドを含めます。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• id: 文字列

問合せパラメータ

• search(オプション): 文字列
  検索条件。

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• allow_override(オプション): ブール
  このプロジェクトを使用するジョブ・テンプレートでSCMブランチまたはリビジョンの変更を許可します。
• credential(オプション): 整数
• custom_virtualenv(オプション): 文字列
  使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス
• description(オプション): 文字列
• local_path(オプション): 文字列
  このプロジェクトのプレイブックおよび関連ファイルを含む(PROJECTS_ROOTに対して相対的な)ローカル・パス。
• name: 文字列
• organization(オプション): 整数
  このテンプレートへのアクセス権を決定するために使用される組織。
• scm_branch(オプション): 文字列
  チェックアウトする特定のブランチ、タグまたはコミット。
• scm_clean(オプション): ブール
  プロジェクトを同期化する前にローカルの変更を破棄します。
• scm_delete_on_update(オプション): ブール
  同期化する前にプロジェクトを削除します。
• scm_refspec(オプション): 文字列
  gitプロジェクトについて、フェッチする追加のrefspec。
• scm_type(オプション): 文字列
  プロジェクトを格納するために使用するソース・コントロール・システムを指定します。
• scm_update_cache_timeout(オプション): 整数
  最後のプロジェクト更新が実行された何秒後に、新しいプロジェクト更新がジョブの依存関係として起動されるか。
• scm_update_on_launch(オプション): ブール
  プロジェクトを使用するジョブが起動されたときにプロジェクトを更新します。
• scm_url(オプション): 文字列
  プロジェクトが格納される場所。
• timeout(オプション): 整数
  タスクが取り消されるまでの実行時間(秒)。

{
    "properties":{
        "allow_override":{
            "description":"Allow changing the SCM branch or revision in a job template that uses this project.",
            "type":"boolean"
        },
        "credential":{
            "description":"",
            "type":"integer"
        },
        "custom_virtualenv":{
            "description":"Local absolute file path containing a custom Python virtualenv to use",
            "type":"string"
        },
        "description":{
            "description":"",
            "type":"string"
        },
        "local_path":{
            "description":"Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.",
            "type":"string"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "organization":{
            "description":"The organization used to determine access to this template.",
            "type":"integer"
        },
        "scm_branch":{
            "description":"Specific branch, tag or commit to checkout.",
            "type":"string"
        },
        "scm_clean":{
            "description":"Discard any local changes before syncing the project.",
            "type":"boolean"
        },
        "scm_delete_on_update":{
            "description":"Delete the project before syncing.",
            "type":"boolean"
        },
        "scm_refspec":{
            "description":"For git projects, an additional refspec to fetch.",
            "type":"string"
        },
        "scm_type":{
            "description":"Specifies the source control system used to store the project.",
            "type":"string"
        },
        "scm_update_cache_timeout":{
            "description":"The number of seconds after the last project update ran that a new project update will be launched as a job dependency.",
            "type":"integer"
        },
        "scm_update_on_launch":{
            "description":"Update the project when a job is launched that uses the project.",
            "type":"boolean"
        },
        "scm_url":{
            "description":"The location where the project is stored.",
            "type":"string"
        },
        "timeout":{
            "description":"The amount of time (in seconds) to run before the task is canceled.",
            "type":"integer"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

先頭に戻る

レスポンス

200レスポンス

先頭に戻る