@templmf/temp-solf-lmf 0.0.109 → 0.0.110

package/gitlab-foss-8-17-stable/doc/api/branches.md

@@ -1,260 +0,0 @@
-# Branches
-
-## List repository branches
-
-Get a list of repository branches from a project, sorted by name alphabetically.
-
-```
-GET /projects/:id/repository/branches
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/repository/branches
-```
-
-Example response:
-
-```json
-[
-  {
-    "name": "master",
-    "merged": false,
-    "protected": true,
-    "developers_can_push": false,
-    "developers_can_merge": false,
-    "commit": {
-      "author_email": "john@example.com",
-      "author_name": "John Smith",
-      "authored_date": "2012-06-27T05:51:39-07:00",
-      "committed_date": "2012-06-28T03:44:20-07:00",
-      "committer_email": "john@example.com",
-      "committer_name": "John Smith",
-      "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
-      "message": "add projects API",
-      "parent_ids": [
-        "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
-      ]
-    }
-  },
-  ...
-]
-```
-
-## Get single repository branch
-
-Get a single project repository branch.
-
-```
-GET /projects/:id/repository/branches/:branch
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `branch` | string | yes | The name of the branch |
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/repository/branches/master
-```
-
-Example response:
-
-```json
-{
-  "name": "master",
-  "merged": false,
-  "protected": true,
-  "developers_can_push": false,
-  "developers_can_merge": false,
-  "commit": {
-    "author_email": "john@example.com",
-    "author_name": "John Smith",
-    "authored_date": "2012-06-27T05:51:39-07:00",
-    "committed_date": "2012-06-28T03:44:20-07:00",
-    "committer_email": "john@example.com",
-    "committer_name": "John Smith",
-    "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
-    "message": "add projects API",
-    "parent_ids": [
-      "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
-    ]
-  }
-}
-```
-
-## Protect repository branch
-
-Protects a single project repository branch. This is an idempotent function,
-protecting an already protected repository branch still returns a `200 OK`
-status code.
-
-```
-PUT /projects/:id/repository/branches/:branch/protect
-```
-
-```bash
-curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/repository/branches/master/protect?developers_can_push=true&developers_can_merge=true
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `branch` | string | yes | The name of the branch |
-| `developers_can_push` | boolean | no | Flag if developers can push to the branch |
-| `developers_can_merge` | boolean | no | Flag if developers can merge to the branch |
-
-Example response:
-
-```json
-{
-  "commit": {
-    "author_email": "john@example.com",
-    "author_name": "John Smith",
-    "authored_date": "2012-06-27T05:51:39-07:00",
-    "committed_date": "2012-06-28T03:44:20-07:00",
-    "committer_email": "john@example.com",
-    "committer_name": "John Smith",
-    "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
-    "message": "add projects API",
-    "parent_ids": [
-      "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
-    ]
-  },
-  "name": "master",
-  "merged": false,
-  "protected": true,
-  "developers_can_push": true,
-  "developers_can_merge": true
-}
-```
-
-## Unprotect repository branch
-
-Unprotects a single project repository branch. This is an idempotent function,
-unprotecting an already unprotected repository branch still returns a `200 OK`
-status code.
-
-```
-PUT /projects/:id/repository/branches/:branch/unprotect
-```
-
-```bash
-curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/repository/branches/master/unprotect
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `branch` | string | yes | The name of the branch |
-
-Example response:
-
-```json
-{
-  "commit": {
-    "author_email": "john@example.com",
-    "author_name": "John Smith",
-    "authored_date": "2012-06-27T05:51:39-07:00",
-    "committed_date": "2012-06-28T03:44:20-07:00",
-    "committer_email": "john@example.com",
-    "committer_name": "John Smith",
-    "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
-    "message": "add projects API",
-    "parent_ids": [
-      "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
-    ]
-  },
-  "name": "master",
-  "merged": false,
-  "protected": false,
-  "developers_can_push": false,
-  "developers_can_merge": false
-}
-```
-
-## Create repository branch
-
-```
-POST /projects/:id/repository/branches
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id`          | integer | yes | The ID of a project |
-| `branch_name` | string  | yes | The name of the branch |
-| `ref`         | string  | yes | The branch name or commit SHA to create branch from |
-
-```bash
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/repository/branches?branch_name=newbranch&ref=master"
-```
-
-Example response:
-
-```json
-{
-  "commit": {
-    "author_email": "john@example.com",
-    "author_name": "John Smith",
-    "authored_date": "2012-06-27T05:51:39-07:00",
-    "committed_date": "2012-06-28T03:44:20-07:00",
-    "committer_email": "john@example.com",
-    "committer_name": "John Smith",
-    "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
-    "message": "add projects API",
-    "parent_ids": [
-      "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
-    ]
-  },
-  "name": "newbranch",
-  "merged": false,
-  "protected": false,
-  "developers_can_push": false,
-  "developers_can_merge": false
-}
-```
-
-## Delete repository branch
-
-```
-DELETE /projects/:id/repository/branches/:branch
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id`      | integer | yes | The ID of a project |
-| `branch`  | string  | yes | The name of the branch |
-
-In case of an error, an explaining message is provided.
-
-```bash
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/repository/branches/newbranch"
-```
-
-Example response:
-
-```json
-{
-  "branch_name": "newbranch"
-}
-```
-
-## Delete merged branches
-
-Will delete all branches that are merged into the project's default branch.
-
-```
-DELETE /projects/:id/repository/merged_branches
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id`      | integer | yes | The ID of a project |
-
-
-```bash
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/repository/merged_branches"
-```

package/gitlab-foss-8-17-stable/doc/api/broadcast_messages.md

@@ -1,154 +0,0 @@
-# Broadcast Messages
-
-> **Note:** This feature was introduced in GitLab 8.12.
-
-The broadcast message API is only accessible to administrators. All requests by
-guests will respond with `401 Unauthorized`, and all requests by normal users
-will respond with `403 Forbidden`.
-
-## Get all broadcast messages
-
-```
-GET /broadcast_messages
-```
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/broadcast_messages
-```
-
-Example response:
-
-```json
-[
-    {
-        "message":"Example broadcast message",
-        "starts_at":"2016-08-24T23:21:16.078Z",
-        "ends_at":"2016-08-26T23:21:16.080Z",
-        "color":"#E75E40",
-        "font":"#FFFFFF",
-        "id":1,
-        "active": false
-    }
-]
-```
-
-## Get a specific broadcast message
-
-```
-GET /broadcast_messages/:id
-```
-
-| Attribute   | Type     | Required | Description               |
-| ----------- | -------- | -------- | ------------------------- |
-| `id`        | integer  | yes      | Broadcast message ID      |
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/broadcast_messages/1
-```
-
-Example response:
-
-```json
-{
-    "message":"Deploy in progress",
-    "starts_at":"2016-08-24T23:21:16.078Z",
-    "ends_at":"2016-08-26T23:21:16.080Z",
-    "color":"#cecece",
-    "font":"#FFFFFF",
-    "id":1,
-    "active":false
-}
-```
-
-## Create a broadcast message
-
-```
-POST /broadcast_messages
-```
-
-| Attribute   | Type     | Required | Description                                          |
-| ----------- | -------- | -------- | ---------------------------------------------------- |
-| `message`   | string   | yes      | Message to display                                   |
-| `starts_at` | datetime | no       | Starting time (defaults to current time)             |
-| `ends_at`   | datetime | no       | Ending time (defaults to one hour from current time) |
-| `color`     | string   | no       | Background color hex code                            |
-| `font`      | string   | no       | Foreground color hex code                            |
-
-```bash
-curl --data "message=Deploy in progress&color=#cecece" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/broadcast_messages
-```
-
-Example response:
-
-```json
-{
-    "message":"Deploy in progress",
-    "starts_at":"2016-08-26T00:41:35.060Z",
-    "ends_at":"2016-08-26T01:41:35.060Z",
-    "color":"#cecece",
-    "font":"#FFFFFF",
-    "id":1,
-    "active": true
-}
-```
-
-## Update a broadcast message
-
-```
-PUT /broadcast_messages/:id
-```
-
-| Attribute   | Type     | Required | Description               |
-| ----------- | -------- | -------- | ------------------------- |
-| `id`        | integer  | yes      | Broadcast message ID      |
-| `message`   | string   | no       | Message to display        |
-| `starts_at` | datetime | no       | Starting time             |
-| `ends_at`   | datetime | no       | Ending time               |
-| `color`     | string   | no       | Background color hex code |
-| `font`      | string   | no       | Foreground color hex code |
-
-```bash
-curl --request PUT --data "message=Update message&color=#000" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/broadcast_messages/1
-```
-
-Example response:
-
-```json
-{
-    "message":"Update message",
-    "starts_at":"2016-08-26T00:41:35.060Z",
-    "ends_at":"2016-08-26T01:41:35.060Z",
-    "color":"#000",
-    "font":"#FFFFFF",
-    "id":1,
-    "active": true
-}
-```
-
-## Delete a broadcast message
-
-```
-DELETE /broadcast_messages/:id
-```
-
-| Attribute   | Type     | Required | Description               |
-| ----------- | -------- | -------- | ------------------------- |
-| `id`        | integer  | yes      | Broadcast message ID      |
-
-```bash
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/broadcast_messages/1
-```
-
-Example response:
-
-```json
-{
-    "message":"Update message",
-    "starts_at":"2016-08-26T00:41:35.060Z",
-    "ends_at":"2016-08-26T01:41:35.060Z",
-    "color":"#000",
-    "font":"#FFFFFF",
-    "id":1,
-    "active": true
-}
-```

package/gitlab-foss-8-17-stable/doc/api/build_triggers.md

@@ -1,118 +0,0 @@
-# Build triggers
-
-You can read more about [triggering builds through the API](../ci/triggers/README.md).
-
-## List project triggers
-
-Get a list of project's build triggers.
-
-```
-GET /projects/:id/triggers
-```
-
-| Attribute | Type    | required | Description         |
-|-----------|---------|----------|---------------------|
-| `id`      | integer | yes      | The ID of a project |
-
-```
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers"
-```
-
-```json
-[
-    {
-        "created_at": "2015-12-23T16:24:34.716Z",
-        "deleted_at": null,
-        "last_used": "2016-01-04T15:41:21.986Z",
-        "token": "fbdb730c2fbdb095a0862dbd8ab88b",
-        "updated_at": "2015-12-23T16:24:34.716Z"
-    },
-    {
-        "created_at": "2015-12-23T16:25:56.760Z",
-        "deleted_at": null,
-        "last_used": null,
-        "token": "7b9148c158980bbd9bcea92c17522d",
-        "updated_at": "2015-12-23T16:25:56.760Z"
-    }
-]
-```
-
-## Get trigger details
-
-Get details of project's build trigger.
-
-```
-GET /projects/:id/triggers/:token
-```
-
-| Attribute | Type    | required | Description              |
-|-----------|---------|----------|--------------------------|
-| `id`      | integer | yes      | The ID of a project      |
-| `token`   | string  | yes      | The `token` of a trigger |
-
-```
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers/7b9148c158980bbd9bcea92c17522d"
-```
-
-```json
-{
-    "created_at": "2015-12-23T16:25:56.760Z",
-    "deleted_at": null,
-    "last_used": null,
-    "token": "7b9148c158980bbd9bcea92c17522d",
-    "updated_at": "2015-12-23T16:25:56.760Z"
-}
-```
-
-## Create a project trigger
-
-Create a build trigger for a project.
-
-```
-POST /projects/:id/triggers
-```
-
-| Attribute | Type    | required | Description              |
-|-----------|---------|----------|--------------------------|
-| `id`      | integer | yes      | The ID of a project      |
-
-```
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers"
-```
-
-```json
-{
-    "created_at": "2016-01-07T09:53:58.235Z",
-    "deleted_at": null,
-    "last_used": null,
-    "token": "6d056f63e50fe6f8c5f8f4aa10edb7",
-    "updated_at": "2016-01-07T09:53:58.235Z"
-}
-```
-
-## Remove a project trigger
-
-Remove a project's build trigger.
-
-```
-DELETE /projects/:id/triggers/:token
-```
-
-| Attribute | Type    | required | Description              |
-|-----------|---------|----------|--------------------------|
-| `id`      | integer | yes      | The ID of a project      |
-| `token`   | string  | yes      | The `token` of a trigger |
-
-```
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers/7b9148c158980bbd9bcea92c17522d"
-```
-
-```json
-{
-    "created_at": "2015-12-23T16:25:56.760Z",
-    "deleted_at": "2015-12-24T12:32:20.100Z",
-    "last_used": null,
-    "token": "7b9148c158980bbd9bcea92c17522d",
-    "updated_at": "2015-12-24T12:32:20.100Z"
-}
-```

package/gitlab-foss-8-17-stable/doc/api/build_variables.md

@@ -1,128 +0,0 @@
-# Build Variables
-
-## List project variables
-
-Get list of a project's build variables.
-
-```
-GET /projects/:id/variables
-```
-
-| Attribute | Type    | required | Description         |
-|-----------|---------|----------|---------------------|
-| `id`      | integer | yes      | The ID of a project |
-
-```
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/variables"
-```
-
-```json
-[
-    {
-        "key": "TEST_VARIABLE_1",
-        "value": "TEST_1"
-    },
-    {
-        "key": "TEST_VARIABLE_2",
-        "value": "TEST_2"
-    }
-]
-```
-
-## Show variable details
-
-Get the details of a project's specific build variable.
-
-```
-GET /projects/:id/variables/:key
-```
-
-| Attribute | Type    | required | Description           |
-|-----------|---------|----------|-----------------------|
-| `id`      | integer | yes      | The ID of a project   |
-| `key`     | string  | yes      | The `key` of a variable |
-
-```
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/variables/TEST_VARIABLE_1"
-```
-
-```json
-{
-    "key": "TEST_VARIABLE_1",
-    "value": "TEST_1"
-}
-```
-
-## Create variable
-
-Create a new build variable.
-
-```
-POST /projects/:id/variables
-```
-
-| Attribute | Type    | required | Description           |
-|-----------|---------|----------|-----------------------|
-| `id`      | integer | yes      | The ID of a project   |
-| `key`     | string  | yes      | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed |
-| `value`   | string  | yes      | The `value` of a variable |
-
-```
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/variables" --form "key=NEW_VARIABLE" --form "value=new value"
-```
-
-```json
-{
-    "key": "NEW_VARIABLE",
-    "value": "new value"
-}
-```
-
-## Update variable
-
-Update a project's build variable.
-
-```
-PUT /projects/:id/variables/:key
-```
-
-| Attribute | Type    | required | Description             |
-|-----------|---------|----------|-------------------------|
-| `id`      | integer | yes      | The ID of a project     |
-| `key`     | string  | yes      | The `key` of a variable   |
-| `value`   | string  | yes      | The `value` of a variable |
-
-```
-curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/variables/NEW_VARIABLE" --form "value=updated value"
-```
-
-```json
-{
-    "key": "NEW_VARIABLE",
-    "value": "updated value"
-}
-```
-
-## Remove variable
-
-Remove a project's build variable.
-
-```
-DELETE /projects/:id/variables/:key
-```
-
-| Attribute | Type    | required | Description             |
-|-----------|---------|----------|-------------------------|
-| `id`      | integer | yes      | The ID of a project     |
-| `key`     | string  | yes      | The `key` of a variable |
-
-```
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/variables/VARIABLE_1"
-```
-
-```json
-{
-    "key": "VARIABLE_1",
-    "value": "VALUE_1"
-}
-```