@templmf/temp-solf-lmf 0.0.109 → 0.0.110

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

@@ -1,56 +0,0 @@
-# Session
-
-## Deprecation Notice
-
-1. Starting in GitLab 8.11, this feature has been *disabled* for users with two-factor authentication turned on.
-2. These users can access the API using [personal access tokens] instead.
-
----
-
-You can login with both GitLab and LDAP credentials in order to obtain the
-private token.
-
-```
-POST /session
-```
-
-| Attribute  | Type    | Required | Description |
-| ---------- | ------- | -------- | -------- |
-| `login`    | string  | yes      | The username of the user|
-| `email`    | string  | yes if login is not provided | The email of the user |
-| `password` | string  | yes     | The password of the user |
-
-```bash
-curl --request POST "https://gitlab.example.com/api/v3/session?login=john_smith&password=strongpassw0rd"
-```
-
-Example response:
-
-```json
-{
-  "name": "John Smith",
-  "username": "john_smith",
-  "id": 32,
-  "state": "active",
-  "avatar_url": null,
-  "created_at": "2015-01-29T21:07:19.440Z",
-  "is_admin": true,
-  "bio": null,
-  "skype": "",
-  "linkedin": "",
-  "twitter": "",
-  "website_url": "",
-  "email": "john@example.com",
-  "theme_id": 1,
-  "color_scheme_id": 1,
-  "projects_limit": 10,
-  "current_sign_in_at": "2015-07-07T07:10:58.392Z",
-  "identities": [],
-  "can_create_group": true,
-  "can_create_project": true,
-  "two_factor_enabled": false,
-  "private_token": "9koXpg98eAheJpvBs5tK"
-}
-```
-
-[personal access tokens]: ./README.md#personal-access-tokens

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

@@ -1,126 +0,0 @@
-# Application settings
-
-These API calls allow you to read and modify GitLab instance application
-settings as appear in `/admin/application_settings`. You have to be an
-administrator in order to perform this action.
-
-## Get current application settings
-
-List the current application settings of the GitLab instance.
-
-```
-GET /application/settings
-```
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/application/settings
-```
-
-Example response:
-
-```json
-{
-   "default_projects_limit" : 10,
-   "signup_enabled" : true,
-   "id" : 1,
-   "default_branch_protection" : 2,
-   "restricted_visibility_levels" : [],
-   "signin_enabled" : true,
-   "after_sign_out_path" : null,
-   "max_attachment_size" : 10,
-   "user_oauth_applications" : true,
-   "updated_at" : "2016-01-04T15:44:55.176Z",
-   "session_expire_delay" : 10080,
-   "home_page_url" : null,
-   "default_snippet_visibility" : 0,
-   "domain_whitelist" : [],
-   "domain_blacklist_enabled" : false,
-   "domain_blacklist" : [],
-   "created_at" : "2016-01-04T15:44:55.176Z",
-   "default_project_visibility" : 0,
-   "gravatar_enabled" : true,
-   "sign_in_text" : null,
-   "container_registry_token_expire_delay": 5,
-   "repository_storage": "default",
-   "repository_storages": ["default"],
-   "koding_enabled": false,
-   "koding_url": null,
-   "plantuml_enabled": false,
-   "plantuml_url": null,
-   "terminal_max_session_time": 0
-}
-```
-
-## Change application settings
-
-```
-PUT /application/settings
-```
-
-| Attribute | Type | Required | Description |
-| --------- | ---- | :------: | ----------- |
-| `default_projects_limit` | integer  | no | Project limit per user. Default is `10` |
-| `signup_enabled`    | boolean | no  | Enable registration. Default is `true`. |
-| `signin_enabled`    | boolean | no  | Enable login via a GitLab account. Default is `true`. |
-| `gravatar_enabled`  | boolean | no  | Enable Gravatar |
-| `sign_in_text`      | string  | no  | Text on login page |
-| `home_page_url`     | string  | no  | Redirect to this URL when not logged in |
-| `default_branch_protection` | integer | no | Determine if developers can push to master. Can take `0` _(not protected, both developers and masters can push new commits, force push or delete the branch)_, `1` _(partially protected, developers can push new commits, but cannot force push or delete the branch, masters can do anything)_ or `2` _(fully protected, developers cannot push new commits, force push or delete the branch, masters can do anything)_ as a parameter. Default is `2`. |
-| `restricted_visibility_levels` | array of integers | no | Selected levels cannot be used by non-admin users for projects or snippets. Can take `0` _(Private)_, `1` _(Internal)_ and `2` _(Public)_ as a parameter. Default is null which means there is no restriction. |
-| `max_attachment_size` | integer | no | Limit attachment size in MB |
-| `session_expire_delay` | integer | no | Session duration in minutes. GitLab restart is required to apply changes |
-| `default_project_visibility` | integer | no | What visibility level new projects receive. Can take `0` _(Private)_, `1` _(Internal)_ and `2` _(Public)_ as a parameter. Default is `0`.|
-| `default_snippet_visibility` | integer | no | What visibility level new snippets receive. Can take `0` _(Private)_, `1` _(Internal)_ and `2` _(Public)_ as a parameter. Default is `0`.|
-| `domain_whitelist` | array of strings | no | Force people to use only corporate emails for sign-up. Default is null, meaning there is no restriction. |
-| `domain_blacklist_enabled` | boolean | no | Enable/disable the `domain_blacklist` |
-| `domain_blacklist` | array of strings | yes (if `domain_blacklist_enabled` is `true`) | People trying to sign-up with emails from this domain will not be allowed to do so. |
-| `user_oauth_applications` | boolean | no | Allow users to register any application to use GitLab as an OAuth provider |
-| `after_sign_out_path` | string | no | Where to redirect users after logout |
-| `container_registry_token_expire_delay` | integer | no | Container Registry token duration in minutes |
-| `repository_storages` | array of strings | no | A list of names of enabled storage paths, taken from `gitlab.yml`. New projects will be created in one of these stores, chosen at random. |
-| `repository_storage` | string | no | The first entry in `repository_storages`. Deprecated, but retained for compatibility reasons |
-| `enabled_git_access_protocol` | string | no | Enabled protocols for Git access. Allowed values are: `ssh`, `http`, and `nil` to allow both protocols. |
-| `koding_enabled` | boolean | no | Enable Koding integration. Default is `false`. |
-| `koding_url` | string | yes (if `koding_enabled` is `true`) |  The Koding instance URL for integration. |
-| `disabled_oauth_sign_in_sources` | Array of strings | no | Disabled OAuth sign-in sources |
-| `plantuml_enabled` | boolean | no | Enable PlantUML integration. Default is `false`. |
-| `plantuml_url` | string | yes (if `plantuml_enabled` is `true`) |  The PlantUML instance URL for integration. |
-| `terminal_max_session_time` | integer | no | Maximum time for web terminal websocket connection (in seconds). Set to 0 for unlimited time. |
-
-```bash
-curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/application/settings?signup_enabled=false&default_project_visibility=1
-```
-
-Example response:
-
-```json
-{
-  "id": 1,
-  "default_projects_limit": 10,
-  "signup_enabled": true,
-  "signin_enabled": true,
-  "gravatar_enabled": true,
-  "sign_in_text": "",
-  "created_at": "2015-06-12T15:51:55.432Z",
-  "updated_at": "2015-06-30T13:22:42.210Z",
-  "home_page_url": "",
-  "default_branch_protection": 2,
-  "restricted_visibility_levels": [],
-  "max_attachment_size": 10,
-  "session_expire_delay": 10080,
-  "default_project_visibility": 1,
-  "default_snippet_visibility": 0,
-  "domain_whitelist": [],
-  "domain_blacklist_enabled" : false,
-  "domain_blacklist" : [],
-  "user_oauth_applications": true,
-  "after_sign_out_path": "",
-  "container_registry_token_expire_delay": 5,
-  "repository_storage": "default",
-  "koding_enabled": false,
-  "koding_url": null,
-  "plantuml_enabled": false,
-  "plantuml_url": null,
-  "terminal_max_session_time": 0
-}
-```

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

@@ -1,152 +0,0 @@
-# Sidekiq Metrics
-
->**Note:** This endpoint is only available on GitLab 8.9 and above.
-
-This API endpoint allows you to retrieve some information about the current state
-of Sidekiq, its jobs, queues, and processes.
-
-## Get the current Queue Metrics
-
-List information about all the registered queues, their backlog and their
-latency.
-
-```
-GET /sidekiq/queue_metrics
-```
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/sidekiq/queue_metrics
-```
-
-Example response:
-
-```json
-{
-  "queues": {
-    "default": {
-      "backlog": 0,
-      "latency": 0
-    }
-  }
-}
-```
-
-## Get the current Process Metrics
-
-List information about all the Sidekiq workers registered to process your queues.
-
-```
-GET /sidekiq/process_metrics
-```
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/sidekiq/process_metrics
-```
-
-Example response:
-
-```json
-{
-  "processes": [
-    {
-      "hostname": "gitlab.example.com",
-      "pid": 5649,
-      "tag": "gitlab",
-      "started_at": "2016-06-14T10:45:07.159-05:00",
-      "queues": [
-        "post_receive",
-        "mailers",
-        "archive_repo",
-        "system_hook",
-        "project_web_hook",
-        "gitlab_shell",
-        "incoming_email",
-        "runner",
-        "common",
-        "default"
-      ],
-      "labels": [],
-      "concurrency": 25,
-      "busy": 0
-    }
-  ]
-}
-```
-
-## Get the current Job Statistics
-
-List information about the jobs that Sidekiq has performed.
-
-```
-GET /sidekiq/job_stats
-```
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/sidekiq/job_stats
-```
-
-Example response:
-
-```json
-{
-  "jobs": {
-    "processed": 2,
-    "failed": 0,
-    "enqueued": 0
-  }
-}
-```
-
-## Get a compound response of all the previously mentioned metrics
-
-List all the currently available information about Sidekiq.
-
-```
-GET /sidekiq/compound_metrics
-```
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/sidekiq/compound_metrics
-```
-
-Example response:
-
-```json
-{
-  "queues": {
-    "default": {
-      "backlog": 0,
-      "latency": 0
-    }
-  },
-  "processes": [
-    {
-      "hostname": "gitlab.example.com",
-      "pid": 5649,
-      "tag": "gitlab",
-      "started_at": "2016-06-14T10:45:07.159-05:00",
-      "queues": [
-        "post_receive",
-        "mailers",
-        "archive_repo",
-        "system_hook",
-        "project_web_hook",
-        "gitlab_shell",
-        "incoming_email",
-        "runner",
-        "common",
-        "default"
-      ],
-      "labels": [],
-      "concurrency": 25,
-      "busy": 0
-    }
-  ],
-  "jobs": {
-    "processed": 2,
-    "failed": 0,
-    "enqueued": 0
-  }
-}
-```
-

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

@@ -1,232 +0,0 @@
-# Snippets
-
-> [Introduced][ce-6373] in GitLab 8.15.
-
-### 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 to 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 current user's snippets.
-
-```
-GET /snippets
-```
-
-## Single snippet
-
-Get a single snippet.
-
-```
-GET /snippets/:id
-```
-
-Parameters:
-
-| Attribute          | Type    | Required | Description                   |
-| ---------          | ----    | -------- | -----------                   |
-| `id`               | Integer | yes      | The ID of a snippet           |
-
-``` bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/snippets/1
-```
-
-Example response:
-
-``` 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"
-  },
-  "expires_at": null,
-  "updated_at": "2012-06-28T10:52:04Z",
-  "created_at": "2012-06-28T10:52:04Z",
-  "web_url": "http://example.com/snippets/1",
-}
-```
-
-## Create new snippet
-
-Creates a new snippet. The user must have permission to create new snippets.
-
-```
-POST /snippets
-```
-
-Parameters:
-
-| Attribute          | Type    | Required | Description                |
-| ---------          | ----    | -------- | -----------                |
-| `title`            | String  | yes      | The title of a snippet     |
-| `file_name`        | String  | yes      | The name of a snippet file |
-| `content`          | String  | yes      | The content of a snippet   |
-| `visibility_level` | Integer | yes      | The snippet's visibility   |
-
-
-``` bash
-curl --request POST --data '{"title": "This is a snippet", "content": "Hello world", "file_name": "test.txt", "visibility_level": 10 }' --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/snippets
-```
-
-Example response:
-
-``` json
-{
-  "id": 1,
-  "title": "This is a snippet",
-  "file_name": "test.txt",
-  "author": {
-    "id": 1,
-    "username": "john_smith",
-    "email": "john@example.com",
-    "name": "John Smith",
-    "state": "active",
-    "created_at": "2012-05-23T08:00:58Z"
-  },
-  "expires_at": null,
-  "updated_at": "2012-06-28T10:52:04Z",
-  "created_at": "2012-06-28T10:52:04Z",
-  "web_url": "http://example.com/snippets/1",
-}
-```
-
-## Update snippet
-
-Updates an existing snippet. The user must have permission to change an existing snippet.
-
-```
-PUT /snippets/:id
-```
-
-Parameters:
-
-| Attribute          | Type    | Required | Description                |
-| ---------          | ----    | -------- | -----------                |
-| `id`               | Integer | yes      | The ID of a snippet        |
-| `title`            | String  | no       | The title of a snippet     |
-| `file_name`        | String  | no       | The name of a snippet file |
-| `content`          | String  | no       | The content of a snippet   |
-| `visibility_level` | Integer | no       | The snippet's visibility   |
-
-
-``` bash
-curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --data '{"title": "foo", "content": "bar"}' https://gitlab.example.com/api/v3/snippets/1
-```
-
-Example response:
-
-``` 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"
-  },
-  "expires_at": null,
-  "updated_at": "2012-06-28T10:52:04Z",
-  "created_at": "2012-06-28T10:52:04Z",
-  "web_url": "http://example.com/snippets/1",
-}
-```
-
-## Delete snippet
-
-Deletes an existing snippet. 
-
-```
-DELETE /snippets/:id
-```
-
-Parameters:
-
-| Attribute          | Type    | Required | Description                   |
-| ---------          | ----    | -------- | -----------                   |
-| `id`               | Integer | yes      | The ID of a snippet           |
-
-
-```
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/snippets/1"
-```
-
-upon successful delete a `204 No content` HTTP code shall be expected, with no data,
-but if the snippet is non-existent, a `404 Not Found` will be returned.
-
-## Explore all public snippets
-
-```
-GET /snippets/public
-```
-
-| Attribute  | Type    | Required | Description                           |
-| ---------  | ----    | -------- | -----------                           |
-| `per_page` | Integer | no       | number of snippets to return per page |
-| `page`     | Integer | no       | the page to retrieve                  |
-
-``` bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/snippets/public?per_page=2&page=1
-```
-
-Example response:
-
-``` json
-[
-    {
-        "author": {
-            "avatar_url": "http://www.gravatar.com/avatar/edaf55a9e363ea263e3b981d09e0f7f7?s=80&d=identicon",
-            "id": 12,
-            "name": "Libby Rolfson",
-            "state": "active",
-            "username": "elton_wehner",
-            "web_url": "http://localhost:3000/elton_wehner"
-        },
-        "created_at": "2016-11-25T16:53:34.504Z",
-        "file_name": "oconnerrice.rb",
-        "id": 49,
-        "raw_url": "http://localhost:3000/snippets/49/raw",
-        "title": "Ratione cupiditate et laborum temporibus.",
-        "updated_at": "2016-11-25T16:53:34.504Z",
-        "web_url": "http://localhost:3000/snippets/49"
-    },
-    {
-        "author": {
-            "avatar_url": "http://www.gravatar.com/avatar/36583b28626de71061e6e5a77972c3bd?s=80&d=identicon",
-            "id": 16,
-            "name": "Llewellyn Flatley",
-            "state": "active",
-            "username": "adaline",
-            "web_url": "http://localhost:3000/adaline"
-        },
-        "created_at": "2016-11-25T16:53:34.479Z",
-        "file_name": "muellershields.rb",
-        "id": 48,
-        "raw_url": "http://localhost:3000/snippets/48/raw",
-        "title": "Minus similique nesciunt vel fugiat qui ullam sunt.",
-        "updated_at": "2016-11-25T16:53:34.479Z",
-        "web_url": "http://localhost:3000/snippets/48"
-    }
-]
-```
-