プロジェクトテンプレートAPI

このAPIは、これらのエンドポイントのプロジェクト固有バージョンです:

これらのエンドポイントは API バージョン 5 で削除される予定です。

インスタンス全体に共通するテンプレートに加え、プロジェクト固有のテンプレートもこのAPIエンドポイントから利用できます。

グループレベルのファイルテンプレートもサポートされています。

特定のタイプのテンプレートをすべて取得

GET /projects/:id/templates/:type
属性種類必須説明
id整数または文字列。 {チェックサークル}はい プロジェクトのIDまたはURLエンコードされたパス
type文字列です。 {チェックサークル}はいテンプレートのタイプ。指定可能な値は以下のとおりです:dockerfiles gitignores,gitlab_ci_ymls,licenses,issues, またはmerge_requests

レスポンスの例(ライセンス):

[
  {
    "key": "epl-1.0",
    "name": "Eclipse Public License 1.0"
  },
  {
    "key": "lgpl-3.0",
    "name": "GNU Lesser General Public License v3.0"
  },
  {
    "key": "unlicense",
    "name": "The Unlicense"
  },
  {
    "key": "agpl-3.0",
    "name": "GNU Affero General Public License v3.0"
  },
  {
    "key": "gpl-3.0",
    "name": "GNU General Public License v3.0"
  },
  {
    "key": "bsd-3-clause",
    "name": "BSD 3-clause \"New\" or \"Revised\" License"
  },
  {
    "key": "lgpl-2.1",
    "name": "GNU Lesser General Public License v2.1"
  },
  {
    "key": "mit",
    "name": "MIT License"
  },
  {
    "key": "apache-2.0",
    "name": "Apache License 2.0"
  },
  {
    "key": "bsd-2-clause",
    "name": "BSD 2-clause \"Simplified\" License"
  },
  {
    "key": "mpl-2.0",
    "name": "Mozilla Public License 2.0"
  },
  {
    "key": "gpl-2.0",
    "name": "GNU General Public License v2.0"
  }
]

特定のタイプのテンプレートを1つ取得

GET /projects/:id/templates/:type/:name
属性種類必須説明
id整数または文字列。 {チェックサークル}はい プロジェクトのIDまたはURLエンコードされたパス
name文字列です。 {チェックサークル}はいコレクション・エンドポイントから取得したテンプレートのキー。
type文字列です。 {チェックサークル}はいテンプレートのタイプ。のいずれか:dockerfiles gitignores,gitlab_ci_ymls,licenses,issues, またはmerge_requests
fullname文字列です。 {点線円}いいえテンプレートでプレースホルダを展開するときに使用する著作権者のフルネーム。ライセンスにのみ影響します。
project文字列です。 {点線円}いいえテンプレートでプレースホルダを展開するときに使用するプロジェクト名。ライセンスにのみ影響します。
source_template_project_id整数。 {点線円}いいえ指定されたテンプレートが保存されているプロジェクトID。異なるプロジェクトの複数のテンプレートが同じ名前である場合に役立ちます。複数のテンプレートが同じ名前を持つ場合、source_template_project_id が指定されていなければ、closest ancestor から一致するものが返されます、

応答例(Dockerfile):

{
  "name": "Binary",
  "content": "# This file is a template, and might need editing before it works on your project.\n# This Dockerfile installs a compiled binary into a bare system.\n# You must either commit your compiled binary into source control (not recommended)\n# or build the binary first as part of a CI/CD pipeline.\n\nFROM buildpack-deps:buster\n\nWORKDIR /usr/local/bin\n\n# Change `app` to whatever your binary is called\nAdd app .\nCMD [\"./app\"]\n"
}

応答例(ライセンス):

{
  "key": "mit",
  "name": "MIT License",
  "nickname": null,
  "popular": true,
  "html_url": "http://choosealicense.com/licenses/mit/",
  "source_url": "https://opensource.org/licenses/MIT",
  "description": "A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.",
  "conditions": [
    "include-copyright"
  ],
  "permissions": [
    "commercial-use",
    "modifications",
    "distribution",
    "private-use"
  ],
  "limitations": [
    "liability",
    "warranty"
  ],
  "content": "MIT License\n\nCopyright (c) 2018 [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
}