@templmf/temp-solf-lmf 0.0.109 → 0.0.110

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

@@ -1,177 +0,0 @@
-# Notification settings
-
->**Note:** This feature was [introduced][ce-5632] in GitLab 8.12.
-
-**Valid notification levels**
-
-The notification levels are defined in the `NotificationSetting.level` model enumeration. Currently, these levels are recognized:
-
-```
-disabled
-participating
-watch
-global
-mention
-custom
-```
-
-If the `custom` level is used, specific email events can be controlled. Notification email events are defined in the `NotificationSetting::EMAIL_EVENTS` model variable. Currently, these events are recognized:
-
-```
-new_note
-new_issue
-reopen_issue
-close_issue
-reassign_issue
-new_merge_request
-reopen_merge_request
-close_merge_request
-reassign_merge_request
-merge_merge_request
-failed_pipeline
-success_pipeline
-```
-
-## Global notification settings
-
-Get current notification settings and email address.
-
-```
-GET /notification_settings
-```
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/notification_settings
-```
-
-Example response:
-
-```json
-{
-  "level": "participating",
-  "notification_email": "admin@example.com"
-}
-```
-
-## Update global notification settings
-
-Update current notification settings and email address.
-
-```
-PUT /notification_settings
-```
-
-```bash
-curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/notification_settings?level=watch
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `level` | string | no | The global notification level |
-| `notification_email` | string | no | The email address to send notifications |
-| `new_note` | boolean | no | Enable/disable this notification |
-| `new_issue` | boolean | no | Enable/disable this notification |
-| `reopen_issue` | boolean | no | Enable/disable this notification |
-| `close_issue` | boolean | no | Enable/disable this notification |
-| `reassign_issue` | boolean | no | Enable/disable this notification |
-| `new_merge_request` | boolean | no | Enable/disable this notification |
-| `reopen_merge_request` | boolean | no | Enable/disable this notification |
-| `close_merge_request` | boolean | no | Enable/disable this notification |
-| `reassign_merge_request` | boolean | no | Enable/disable this notification |
-| `merge_merge_request` | boolean | no | Enable/disable this notification |
-| `failed_pipeline` | boolean | no | Enable/disable this notification |
-| `success_pipeline` | boolean | no | Enable/disable this notification |
-
-Example response:
-
-```json
-{
-  "level": "watch",
-  "notification_email": "admin@example.com"
-}
-```
-
-## Group / project level notification settings
-
-Get current group or project notification settings.
-
-```
-GET /groups/:id/notification_settings
-GET /projects/:id/notification_settings
-```
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/groups/5/notification_settings
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/8/notification_settings
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer/string | yes | The group/project ID or path |
-
-Example response:
-
-```json
-{
-  "level": "global"
-}
-```
-
-## Update group/project level notification settings
-
-Update current group/project notification settings.
-
-```
-PUT /groups/:id/notification_settings
-PUT /projects/:id/notification_settings
-```
-
-```bash
-curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/groups/5/notification_settings?level=watch
-curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/8/notification_settings?level=custom&new_note=true
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `id` | integer/string | yes | The group/project ID or path |
-| `level` | string | no | The global notification level |
-| `new_note` | boolean | no | Enable/disable this notification |
-| `new_issue` | boolean | no | Enable/disable this notification |
-| `reopen_issue` | boolean | no | Enable/disable this notification |
-| `close_issue` | boolean | no | Enable/disable this notification |
-| `reassign_issue` | boolean | no | Enable/disable this notification |
-| `new_merge_request` | boolean | no | Enable/disable this notification |
-| `reopen_merge_request` | boolean | no | Enable/disable this notification |
-| `close_merge_request` | boolean | no | Enable/disable this notification |
-| `reassign_merge_request` | boolean | no | Enable/disable this notification |
-| `merge_merge_request` | boolean | no | Enable/disable this notification |
-| `failed_pipeline` | boolean | no | Enable/disable this notification |
-| `success_pipeline` | boolean | no | Enable/disable this notification |
-
-Example responses:
-
-```json
-{
-  "level": "watch"
-}
-
-{
-  "level": "custom",
-  "events": {
-    "new_note": true,
-    "new_issue": false,
-    "reopen_issue": false,
-    "close_issue": false,
-    "reassign_issue": false,
-    "new_merge_request": false,
-    "reopen_merge_request": false,
-    "close_merge_request": false,
-    "reassign_merge_request": false,
-    "merge_merge_request": false,
-    "failed_pipeline": false,
-    "success_pipeline": false
-  }
-}
-```
-
-[ce-5632]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5632

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

@@ -1,137 +0,0 @@
-# GitLab as an OAuth2 provider
-
-This document covers using the OAuth2 protocol to access GitLab.
-
-If you want GitLab to be an OAuth authentication service provider to sign into other services please see the [Oauth2 provider documentation](../integration/oauth_provider.md).
-
-OAuth2 is a protocol that enables us to authenticate a user without requiring them to give their password to a third-party.
-
-This functionality is based on [doorkeeper gem](https://github.com/doorkeeper-gem/doorkeeper)
-
-## Web Application Flow
-
-This is the most common type of flow and is used by server-side clients that wish to access GitLab on a user's behalf.
-
->**Note:**
-This flow **should not** be used for client-side clients as you would leak your `client_secret`. Client-side clients should use the Implicit Grant (which is currently unsupported).
-
-For more detailed information, check out the [RFC spec](http://tools.ietf.org/html/rfc6749#section-4.1)
-
-In the following sections you will be introduced to the three steps needed for this flow.
-
-### 1. Registering the client
-
-First, you should create an application (`/profile/applications`) in your user's account.
-Each application gets a unique App ID and App Secret parameters.
-
->**Note:**
-**You should not share/leak your App ID or App Secret.**
-
-### 2. Requesting authorization
-
-To request the authorization code, you should redirect the user to the `/oauth/authorize` endpoint:
-
-```
-https://gitlab.example.com/oauth/authorize?client_id=APP_ID&redirect_uri=REDIRECT_URI&response_type=code&state=your_unique_state_hash
-```
-
-This will ask the user to approve the applications access to their account and then redirect back to the `REDIRECT_URI` you provided.
-
-The redirect will include the GET `code` parameter, for example:
-
-```
-http://myapp.com/oauth/redirect?code=1234567890&state=your_unique_state_hash
-```
-
-You should then use the `code` to request an access token.
-
->**Important:**
-It is highly recommended that you send a `state` value with the request to `/oauth/authorize` and
-validate that value is returned and matches in the redirect request.
-This is important to prevent [CSRF attacks](http://www.oauthsecurity.com/#user-content-authorization-code-flow),
-`state` really should have been a requirement in the standard!
-
-### 3. Requesting the access token
-
-Once you have the authorization code you can request an `access_token` using the code, to do that you can use any HTTP client. In the following example, we are using Ruby's `rest-client`:
-
-```
-parameters = 'client_id=APP_ID&client_secret=APP_SECRET&code=RETURNED_CODE&grant_type=authorization_code&redirect_uri=REDIRECT_URI'
-RestClient.post 'http://localhost:3000/oauth/token', parameters
-
-# The response will be
-{
- "access_token": "de6780bc506a0446309bd9362820ba8aed28aa506c71eedbe1c5c4f9dd350e54",
- "token_type": "bearer",
- "expires_in": 7200,
- "refresh_token": "8257e65c97202ed1726cf9571600918f3bffb2544b26e00a61df9897668c33a1"
-}
-```
->**Note:**
-The `redirect_uri` must match the `redirect_uri` used in the original authorization request.
-
-You can now make requests to the API with the access token returned.
-
-###  Use the access token to access the API
-
-The access token allows you to make requests to the API on a behalf of a user.
-
-```
-GET https://localhost:3000/api/v3/user?access_token=OAUTH-TOKEN
-```
-
-Or you can put the token to the Authorization header:
-
-```
-curl --header "Authorization: Bearer OAUTH-TOKEN" https://localhost:3000/api/v3/user
-```
-
-## Resource Owner Password Credentials
-
-## Deprecation Notice
-
-1. Starting in GitLab 8.11, the Resource Owner Password Credentials has been *disabled* for users with two-factor authentication turned on.
-2. These users can access the API using [personal access tokens] instead.
-
----
-
-In this flow, a token is requested in exchange for the resource owner credentials (username and password).
-The credentials should only be used when there is a high degree of trust between the resource owner and the client (e.g. the
-client is part of the device operating system or a highly privileged application), and when other authorization grant types are not
-available (such as an authorization code).
-
->**Important:**
-Never store the users credentials and only use this grant type when your client is deployed to a trusted environment, in 99% of cases [personal access tokens] are a better choice.
-
-Even though this grant type requires direct client access to the resource owner credentials, the resource owner credentials are used
-for a single request and are exchanged for an access token.  This grant type can eliminate the need for the client to store the
-resource owner credentials for future use, by exchanging the credentials with a long-lived access token or refresh token.
-You can do POST request to `/oauth/token` with parameters:
-
-```
-{
-  "grant_type"    : "password",
-  "username"      : "user@example.com",
-  "password"      : "secret"
-}
-```
-
-Then, you'll receive the access token back in the response:
-
-```
-{
-  "access_token": "1f0af717251950dbd4d73154fdf0a474a5c5119adad999683f5b450c460726aa",
-  "token_type": "bearer",
-  "expires_in": 7200
-}
-```
-
-For testing you can use the oauth2 ruby gem:
-
-```
-client = OAuth2::Client.new('the_client_id', 'the_client_secret', :site => "http://example.com")
-access_token = client.password.get_token('user@example.com', 'secret')
-puts access_token.token
-```
-
-[personal access tokens]: ./README.md#personal-access-tokens

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

@@ -1,259 +0,0 @@
-# Pipelines API
-
-## List project pipelines
-
-> [Introduced][ce-5837] in GitLab 8.11
-
-```
-GET /projects/:id/pipelines
-```
-
-| 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/pipelines"
-```
-
-Example of response
-
-```json
-[
-  {
-    "id": 47,
-    "status": "pending",
-    "ref": "new-pipeline",
-    "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
-    "before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
-    "tag": false,
-    "yaml_errors": null,
-    "user": {
-      "name": "Administrator",
-      "username": "root",
-      "id": 1,
-      "state": "active",
-      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-      "web_url": "http://localhost:3000/root"
-    },
-    "created_at": "2016-08-16T10:23:19.007Z",
-    "updated_at": "2016-08-16T10:23:19.216Z",
-    "started_at": null,
-    "finished_at": null,
-    "committed_at": null,
-    "duration": null,
-    "coverage": "30.0"
-  },
-  {
-    "id": 48,
-    "status": "pending",
-    "ref": "new-pipeline",
-    "sha": "eb94b618fb5865b26e80fdd8ae531b7a63ad851a",
-    "before_sha": "eb94b618fb5865b26e80fdd8ae531b7a63ad851a",
-    "tag": false,
-    "yaml_errors": null,
-    "user": {
-      "name": "Administrator",
-      "username": "root",
-      "id": 1,
-      "state": "active",
-      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-      "web_url": "http://localhost:3000/root"
-    },
-    "created_at": "2016-08-16T10:23:21.184Z",
-    "updated_at": "2016-08-16T10:23:21.314Z",
-    "started_at": null,
-    "finished_at": null,
-    "committed_at": null,
-    "duration": null,
-    "coverage": null
-  }
-]
-```
-
-## Get a single pipeline
-
-> [Introduced][ce-5837] in GitLab 8.11
-
-```
-GET /projects/:id/pipelines/:pipeline_id
-```
-
-| Attribute  | Type    | Required | Description         |
-|------------|---------|----------|---------------------|
-| `id`       | integer | yes      | The ID of a project |
-| `pipeline_id` | integer | yes      | The ID of a pipeline   |
-
-```
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/pipeline/46"
-```
-
-Example of response
-
-```json
-{
-  "id": 46,
-  "status": "success",
-  "ref": "master",
-  "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
-  "before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
-  "tag": false,
-  "yaml_errors": null,
-  "user": {
-    "name": "Administrator",
-    "username": "root",
-    "id": 1,
-    "state": "active",
-    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-    "web_url": "http://localhost:3000/root"
-  },
-  "created_at": "2016-08-11T11:28:34.085Z",
-  "updated_at": "2016-08-11T11:32:35.169Z",
-  "started_at": null,
-  "finished_at": "2016-08-11T11:32:35.145Z",
-  "committed_at": null,
-  "duration": null,
-  "coverage": "30.0"
-}
-```
-
-## Create a new pipeline
-
-> [Introduced][ce-7209] in GitLab 8.14
-
-```
-POST /projects/:id/pipeline
-```
-
-| Attribute  | Type    | Required | Description         |
-|------------|---------|----------|---------------------|
-| `id`       | integer | yes      | The ID of a project |
-| `ref`       | string | yes      | Reference to commit |
-
-```
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/pipeline?ref=master"
-```
-
-Example of response
-
-```json
-{
-  "id": 61,
-  "sha": "384c444e840a515b23f21915ee5766b87068a70d",
-  "ref": "master",
-  "status": "pending",
-  "before_sha": "0000000000000000000000000000000000000000",
-  "tag": false,
-  "yaml_errors": null,
-  "user": {
-    "name": "Administrator",
-    "username": "root",
-    "id": 1,
-    "state": "active",
-    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-    "web_url": "http://localhost:3000/root"
-  },
-  "created_at": "2016-11-04T09:36:13.747Z",
-  "updated_at": "2016-11-04T09:36:13.977Z",
-  "started_at": null,
-  "finished_at": null,
-  "committed_at": null,
-  "duration": null,
-  "coverage": null
-}
-```
-
-## Retry failed builds in a pipeline
-
-> [Introduced][ce-5837] in GitLab 8.11
-
-```
-POST /projects/:id/pipelines/:pipeline_id/retry
-```
-
-| Attribute  | Type    | Required | Description         |
-|------------|---------|----------|---------------------|
-| `id`       | integer | yes      | The ID of a project |
-| `pipeline_id` | integer | yes   | The ID of a pipeline |
-
-```
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/pipelines/46/retry"
-```
-
-Response:
-
-```json
-{
-  "id": 46,
-  "status": "pending",
-  "ref": "master",
-  "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
-  "before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
-  "tag": false,
-  "yaml_errors": null,
-  "user": {
-    "name": "Administrator",
-    "username": "root",
-    "id": 1,
-    "state": "active",
-    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-    "web_url": "http://localhost:3000/root"
-  },
-  "created_at": "2016-08-11T11:28:34.085Z",
-  "updated_at": "2016-08-11T11:32:35.169Z",
-  "started_at": null,
-  "finished_at": "2016-08-11T11:32:35.145Z",
-  "committed_at": null,
-  "duration": null,
-  "coverage": null
-}
-```
-
-## Cancel a pipelines builds
-
-> [Introduced][ce-5837] in GitLab 8.11
-
-```
-POST /projects/:id/pipelines/:pipeline_id/cancel
-```
-
-| Attribute  | Type    | Required | Description         |
-|------------|---------|----------|---------------------|
-| `id`       | integer | yes      | The ID of a project |
-| `pipeline_id` | integer | yes   | The ID of a pipeline |
-
-```
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/pipelines/46/cancel"
-```
-
-Response:
-
-```json
-{
-  "id": 46,
-  "status": "canceled",
-  "ref": "master",
-  "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
-  "before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
-  "tag": false,
-  "yaml_errors": null,
-  "user": {
-    "name": "Administrator",
-    "username": "root",
-    "id": 1,
-    "state": "active",
-    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-    "web_url": "http://localhost:3000/root"
-  },
-  "created_at": "2016-08-11T11:28:34.085Z",
-  "updated_at": "2016-08-11T11:32:35.169Z",
-  "started_at": null,
-  "finished_at": "2016-08-11T11:32:35.145Z",
-  "committed_at": null,
-  "duration": null,
-  "coverage": null
-}
-```
-
-[ce-5837]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5837
-[ce-7209]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7209

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

@@ -1,118 +0,0 @@
-# Project snippets
-
-### Snippet visibility level
-
-Snippets in GitLab can be either private, internal or public.
-You can set it with the `visibility_level` field in the snippet.
-
-Constants for snippet visibility levels are:
-
-| Visibility | visibility_level | Description |
-| ---------- | ---------------- | ----------- |
-| Private    | `0`  | The snippet is visible only the snippet creator |
-| Internal   | `10` | The snippet is visible for any logged in user |
-| Public     | `20` | The snippet can be accessed without any authentication |
-
-## List snippets
-
-Get a list of project snippets.
-
-```
-GET /projects/:id/snippets
-```
-
-Parameters:
-
-- `id` (required) - The ID of a project
-
-## Single snippet
-
-Get a single project snippet.
-
-```
-GET /projects/:id/snippets/:snippet_id
-```
-
-Parameters:
-
-- `id` (required) - The ID of a project
-- `snippet_id` (required) - The ID of a project's snippet
-
-```json
-{
-  "id": 1,
-  "title": "test",
-  "file_name": "add.rb",
-  "author": {
-    "id": 1,
-    "username": "john_smith",
-    "email": "john@example.com",
-    "name": "John Smith",
-    "state": "active",
-    "created_at": "2012-05-23T08:00:58Z"
-  },
-  "updated_at": "2012-06-28T10:52:04Z",
-  "created_at": "2012-06-28T10:52:04Z",
-  "web_url": "http://example.com/example/example/snippets/1"
-}
-```
-
-## Create new snippet
-
-Creates a new project snippet. The user must have permission to create new snippets.
-
-```
-POST /projects/:id/snippets
-```
-
-Parameters:
-
-- `id` (required) - The ID of a project
-- `title` (required) - The title of a snippet
-- `file_name` (required) - The name of a snippet file
-- `code` (required) - The content of a snippet
-- `visibility_level` (required) - The snippet's visibility
-
-## Update snippet
-
-Updates an existing project snippet. The user must have permission to change an existing snippet.
-
-```
-PUT /projects/:id/snippets/:snippet_id
-```
-
-Parameters:
-
-- `id` (required) - The ID of a project
-- `snippet_id` (required) - The ID of a project's snippet
-- `title` (optional) - The title of a snippet
-- `file_name` (optional) - The name of a snippet file
-- `code` (optional) - The content of a snippet
-- `visibility_level` (optional) - The snippet's visibility
-
-## Delete snippet
-
-Deletes an existing project snippet. This is an idempotent function and deleting a non-existent
-snippet still returns a `200 OK` status code.
-
-```
-DELETE /projects/:id/snippets/:snippet_id
-```
-
-Parameters:
-
-- `id` (required) - The ID of a project
-- `snippet_id` (required) - The ID of a project's snippet
-
-## Snippet content
-
-Returns the raw project snippet as plain text.
-
-```
-GET /projects/:id/snippets/:snippet_id/raw
-```
-
-Parameters:
-
-- `id` (required) - The ID of a project
-- `snippet_id` (required) - The ID of a project's snippet