@templmf/temp-solf-lmf 0.0.109 → 0.0.110

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

@@ -1,374 +0,0 @@
-# Award Emoji
-
-> [Introduced][ce-4575] in GitLab 8.9, Snippet support in 8.12
-
-
-An awarded emoji tells a thousand words, and can be awarded on issues, merge
-requests, snippets, and notes/comments. Issues, merge requests, snippets, and notes are further called
-`awardables`.
-
-## Issues, merge requests, and snippets
-
-### List an awardable's award emoji
-
-Gets a list of all award emoji
-
-```
-GET /projects/:id/issues/:issue_id/award_emoji
-GET /projects/:id/merge_requests/:merge_request_id/award_emoji
-GET /projects/:id/snippets/:snippet_id/award_emoji
-```
-
-Parameters:
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `awardable_id` | integer | yes | The ID of an awardable |
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" http://gitlab.example.com/api/v3/projects/1/issues/80/award_emoji
-```
-
-Example Response:
-
-```json
-[
-  {
-    "id": 4,
-    "name": "1234",
-    "user": {
-      "name": "Administrator",
-      "username": "root",
-      "id": 1,
-      "state": "active",
-      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-      "web_url": "http://gitlab.example.com/root"
-    },
-    "created_at": "2016-06-15T10:09:34.206Z",
-    "updated_at": "2016-06-15T10:09:34.206Z",
-    "awardable_id": 80,
-    "awardable_type": "Issue"
-  },
-  {
-    "id": 1,
-    "name": "microphone",
-    "user": {
-      "name": "User 4",
-      "username": "user4",
-      "id": 26,
-      "state": "active",
-      "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
-      "web_url": "http://gitlab.example.com/user4"
-    },
-    "created_at": "2016-06-15T10:09:34.177Z",
-    "updated_at": "2016-06-15T10:09:34.177Z",
-    "awardable_id": 80,
-    "awardable_type": "Issue"
-  }
-]
-```
-
-### Get single award emoji
-
-Gets a single award emoji from an issue, snippet, or merge request.
-
-```
-GET /projects/:id/issues/:issue_id/award_emoji/:award_id
-GET /projects/:id/merge_requests/:merge_request_id/award_emoji/:award_id
-GET /projects/:id/snippets/:snippet_id/award_emoji/:award_id
-```
-
-Parameters:
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `awardable_id` | integer | yes | The ID of an awardable |
-| `award_id` | integer | yes | The ID of the award emoji |
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" http://gitlab.example.com/api/v3/projects/1/issues/80/award_emoji/1
-```
-
-Example Response:
-
-```json
-{
-  "id": 1,
-  "name": "microphone",
-  "user": {
-    "name": "User 4",
-    "username": "user4",
-    "id": 26,
-    "state": "active",
-    "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
-    "web_url": "http://gitlab.example.com/user4"
-  },
-  "created_at": "2016-06-15T10:09:34.177Z",
-  "updated_at": "2016-06-15T10:09:34.177Z",
-  "awardable_id": 80,
-  "awardable_type": "Issue"
-}
-```
-
-### Award a new emoji
-
-This end point creates an award emoji on the specified resource
-
-```
-POST /projects/:id/issues/:issue_id/award_emoji
-POST /projects/:id/merge_requests/:merge_request_id/award_emoji
-POST /projects/:id/snippets/:snippet_id/award_emoji
-```
-
-Parameters:
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `awardable_id` | integer | yes | The ID of an awardable |
-| `name` | string | yes | The name of the emoji, without colons |
-
-```bash
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" http://gitlab.example.com/api/v3/projects/1/issues/80/award_emoji?name=blowfish
-```
-
-Example Response:
-
-```json
-{
-  "id": 344,
-  "name": "blowfish",
-  "user": {
-    "name": "Administrator",
-    "username": "root",
-    "id": 1,
-    "state": "active",
-    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-    "web_url": "http://gitlab.example.com/root"
-  },
-  "created_at": "2016-06-17T17:47:29.266Z",
-  "updated_at": "2016-06-17T17:47:29.266Z",
-  "awardable_id": 80,
-  "awardable_type": "Issue"
-}  
-```
-
-### Delete an award emoji
-
-Sometimes its just not meant to be, and you'll have to remove your award. Only available to
-admins or the author of the award.
-
-```
-DELETE /projects/:id/issues/:issue_id/award_emoji/:award_id
-DELETE /projects/:id/merge_requests/:merge_request_id/award_emoji/:award_id
-DELETE /projects/:id/snippets/:snippet_id/award_emoji/:award_id
-```
-
-Parameters:
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `issue_id` | integer | yes | The ID of an issue |
-| `award_id` | integer | yes | The ID of a award_emoji |
-
-```bash
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" http://gitlab.example.com/api/v3/projects/1/issues/80/award_emoji/344
-```
-
-Example Response:
-
-```json
-{
-  "id": 344,
-  "name": "blowfish",
-  "user": {
-    "name": "Administrator",
-    "username": "root",
-    "id": 1,
-    "state": "active",
-    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-    "web_url": "http://gitlab.example.com/root"
-  },
-  "created_at": "2016-06-17T17:47:29.266Z",
-  "updated_at": "2016-06-17T17:47:29.266Z",
-  "awardable_id": 80,
-  "awardable_type": "Issue"
-}
-```
-
-## Award Emoji on Notes
-
-The endpoints documented above are available for Notes as well. Notes
-are a sub-resource of Issues, Merge Requests, or Snippets. The examples below
-describe working with Award Emoji on notes for an Issue, but can be
-easily adapted for notes on a Merge Request.
-
-### List a note's award emoji
-
-```
-GET /projects/:id/issues/:issue_id/notes/:note_id/award_emoji
-```
-
-Parameters:
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `issue_id` | integer | yes | The ID of an issue |
-| `note_id` | integer | yes | The ID of an note |
-
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" http://gitlab.example.com/api/v3/projects/1/issues/80/notes/1/award_emoji
-```
-
-Example Response:
-
-```json
-[
-  {
-    "id": 2,
-    "name": "mood_bubble_lightning",
-    "user": {
-      "name": "User 4",
-      "username": "user4",
-      "id": 26,
-      "state": "active",
-      "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
-      "web_url": "http://gitlab.example.com/user4"
-    },
-    "created_at": "2016-06-15T10:09:34.197Z",
-    "updated_at": "2016-06-15T10:09:34.197Z",
-    "awardable_id": 1,
-    "awardable_type": "Note"
-  }
-]
-```
-
-### Get single note's award emoji
-
-```
-GET /projects/:id/issues/:issue_id/notes/:note_id/award_emoji/:award_id
-```
-
-Parameters:
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `issue_id` | integer | yes | The ID of an issue |
-| `note_id` | integer | yes | The ID of a note |
-| `award_id` | integer | yes | The ID of the award emoji |
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" http://gitlab.example.com/api/v3/projects/1/issues/80/notes/1/award_emoji/2
-```
-
-Example Response:
-
-```json
-{
-  "id": 2,
-  "name": "mood_bubble_lightning",
-  "user": {
-    "name": "User 4",
-    "username": "user4",
-    "id": 26,
-    "state": "active",
-    "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
-    "web_url": "http://gitlab.example.com/user4"
-  },
-  "created_at": "2016-06-15T10:09:34.197Z",
-  "updated_at": "2016-06-15T10:09:34.197Z",
-  "awardable_id": 1,
-  "awardable_type": "Note"
-}
-```
-
-### Award a new emoji on a note
-
-```
-POST /projects/:id/issues/:issue_id/notes/:note_id/award_emoji
-```
-
-Parameters:
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `issue_id` | integer | yes | The ID of an issue |
-| `note_id` | integer | yes | The ID of a note |
-| `name` | string | yes | The name of the emoji, without colons |
-
-```bash
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" http://gitlab.example.com/api/v3/projects/1/issues/80/notes/1/award_emoji?name=rocket
-```
-
-Example Response:
-
-```json
-{
-  "id": 345,
-  "name": "rocket",
-  "user": {
-    "name": "Administrator",
-    "username": "root",
-    "id": 1,
-    "state": "active",
-    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-    "web_url": "http://gitlab.example.com/root"
-  },
-  "created_at": "2016-06-17T19:59:55.888Z",
-  "updated_at": "2016-06-17T19:59:55.888Z",
-  "awardable_id": 1,
-  "awardable_type": "Note"
-}
-```
-
-### Delete an award emoji
-
-Sometimes its just not meant to be, and you'll have to remove your award. Only available to
-admins or the author of the award.
-
-```
-DELETE /projects/:id/issues/:issue_id/notes/:note_id/award_emoji/:award_id
-```
-
-Parameters:
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a project |
-| `issue_id` | integer | yes | The ID of an issue |
-| `note_id` | integer | yes | The ID of a note |
-| `award_id` | integer | yes | The ID of a award_emoji |
-
-```bash
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" http://gitlab.example.com/api/v3/projects/1/issues/80/award_emoji/345
-```
-
-Example Response:
-
-```json
-{
-  "id": 345,
-  "name": "rocket",
-  "user": {
-    "name": "Administrator",
-    "username": "root",
-    "id": 1,
-    "state": "active",
-    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-    "web_url": "http://gitlab.example.com/root"
-  },
-  "created_at": "2016-06-17T19:59:55.888Z",
-  "updated_at": "2016-06-17T19:59:55.888Z",
-  "awardable_id": 1,
-  "awardable_type": "Note"
-}
-```
-
-[ce-4575]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/4575

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

@@ -1,241 +0,0 @@
-# Boards
-
-Every API call to boards must be authenticated.
-
-If a user is not a member of a project and the project is private, a `GET`
-request on that project will result to a `404` status code.
-
-## Project Board
-
-Lists Issue Boards in the given project.
-
-```
-GET /projects/:id/boards
-```
-
-| 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/:id/boards
-```
-
-Example response:
-
-```json
-[
-  {
-    "id" : 1,
-    "lists" : [
-      {
-        "id" : 1,
-        "label" : {
-          "name" : "Testing",
-          "color" : "#F0AD4E",
-          "description" : null
-        },
-        "position" : 1
-      },
-      {
-        "id" : 2,
-        "label" : {
-          "name" : "Ready",
-          "color" : "#FF0000",
-          "description" : null
-        },
-        "position" : 2
-      },
-      {
-        "id" : 3,
-        "label" : {
-          "name" : "Production",
-          "color" : "#FF5F00",
-          "description" : null
-        },
-        "position" : 3
-      }
-    ]
-  }
-]
-```
-
-## List board lists
-
-Get a list of the board's lists.
-Does not include `backlog` and `done` lists
-
-```
-GET /projects/:id/boards/:board_id/lists
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id`   | integer  | yes    | The ID of a project |
-| `board_id`   | integer  | yes    | The ID of a board |
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/boards/1/lists
-```
-
-Example response:
-
-```json
-[
-  {
-    "id" : 1,
-    "label" : {
-      "name" : "Testing",
-      "color" : "#F0AD4E",
-      "description" : null
-    },
-    "position" : 1
-  },
-  {
-    "id" : 2,
-    "label" : {
-      "name" : "Ready",
-      "color" : "#FF0000",
-      "description" : null
-    },
-    "position" : 2
-  },
-  {
-    "id" : 3,
-    "label" : {
-      "name" : "Production",
-      "color" : "#FF5F00",
-      "description" : null
-    },
-    "position" : 3
-  }
-]
-```
-
-## Single board list
-
-Get a single board list.
-
-```
-GET /projects/:id/boards/:board_id/lists/:list_id
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id`      | integer | yes   | The ID of a project |
-| `board_id`   | integer  | yes    | The ID of a board |
-| `list_id`| integer | yes   | The ID of a board's list |
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/boards/1/lists/1
-```
-
-Example response:
-
-```json
-{
-  "id" : 1,
-  "label" : {
-    "name" : "Testing",
-    "color" : "#F0AD4E",
-    "description" : null
-  },
-  "position" : 1
-}
-```
-
-## New board list
-
-Creates a new Issue Board list.
-
-```
-POST /projects/:id/boards/:board_id/lists
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id`            | integer | yes | The ID of a project |
-| `board_id`   | integer  | yes    | The ID of a board |
-| `label_id`         | integer  | yes | The ID of a label |
-
-```bash
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/boards/1/lists?label_id=5
-```
-
-Example response:
-
-```json
-{
-  "id" : 1,
-  "label" : {
-    "name" : "Testing",
-    "color" : "#F0AD4E",
-    "description" : null
-  },
-  "position" : 1
-}
-```
-
-## Edit board list
-
-Updates an existing Issue Board list. This call is used to change list position.
-
-```
-PUT /projects/:id/boards/:board_id/lists/:list_id
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id`            | integer | yes | The ID of a project |
-| `board_id`   | integer  | yes    | The ID of a board |
-| `list_id`      | integer | yes | The ID of a board's list |
-| `position`         | integer  | yes  | The position of the list |
-
-```bash
-curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/boards/1/lists/1?position=2
-```
-
-Example response:
-
-```json
-{
-  "id" : 1,
-  "label" : {
-    "name" : "Testing",
-    "color" : "#F0AD4E",
-    "description" : null
-  },
-  "position" : 1
-}
-```
-
-## Delete a board list
-
-Only for admins and project owners. Soft deletes the board list in question.
-
-```
-DELETE /projects/:id/boards/:board_id/lists/:list_id
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id`            | integer | yes | The ID of a project |
-| `board_id`   | integer  | yes    | The ID of a board |
-| `list_id`      | integer | yes | The ID of a board's list |
-
-```bash
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/boards/1/lists/1
-```
-Example response:
-
-```json
-{
-  "id" : 1,
-  "label" : {
-    "name" : "Testing",
-    "color" : "#F0AD4E",
-    "description" : null
-  },
-  "position" : 1
-}
-```