Commit 5d60d323 by Mario Trangoni

docs/*: Fix misspell issues

See,
$ find . -type f | xargs misspell -locale US | grep -vi -e vendor -e node_modules -e devenv -e unknwon | grep docs
parent 9c1b4793
...@@ -230,4 +230,4 @@ By default Grafana will delete dashboards in the database if the file is removed ...@@ -230,4 +230,4 @@ By default Grafana will delete dashboards in the database if the file is removed
> **Note.** Provisioning allows you to overwrite existing dashboards > **Note.** Provisioning allows you to overwrite existing dashboards
> which leads to problems if you re-use settings that are supposed to be unique. > which leads to problems if you re-use settings that are supposed to be unique.
> Be careful not to re-use the same `title` multiple times within a folder > Be careful not to re-use the same `title` multiple times within a folder
> or `uid` within the same installation as this will cause weird behaviours. > or `uid` within the same installation as this will cause weird behaviors.
...@@ -136,7 +136,7 @@ In DingTalk PC Client: ...@@ -136,7 +136,7 @@ In DingTalk PC Client:
2. Click "Robot Manage" item in the pop menu, there will be a new panel call "Robot Manage". 2. Click "Robot Manage" item in the pop menu, there will be a new panel call "Robot Manage".
3. In the "Robot Manage" panel, select "customised: customised robot with Webhook". 3. In the "Robot Manage" panel, select "customized: customized robot with Webhook".
4. In the next new panel named "robot detail", click "Add" button. 4. In the next new panel named "robot detail", click "Add" button.
......
...@@ -163,9 +163,9 @@ org_role = "Viewer" ...@@ -163,9 +163,9 @@ org_role = "Viewer"
Setting | Required | Description | Default Setting | Required | Description | Default
------------ | ------------ | ------------- | ------------- ------------ | ------------ | ------------- | -------------
`group_dn` | Yes | LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard (`"*"`) | `group_dn` | Yes | LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard (`"*"`) |
`org_role` | Yes | Assign users of `group_dn` the organisation role `"Admin"`, `"Editor"` or `"Viewer"` | `org_role` | Yes | Assign users of `group_dn` the organization role `"Admin"`, `"Editor"` or `"Viewer"` |
`org_id` | No | The Grafana organization database id. Setting this allows for multiple group_dn's to be assigned to the same `org_role` provided the `org_id` differs | `1` (default org id) `org_id` | No | The Grafana organization database id. Setting this allows for multiple group_dn's to be assigned to the same `org_role` provided the `org_id` differs | `1` (default org id)
`grafana_admin` | No | When `true` makes user of `group_dn` Grafana server admin. A Grafana server admin has admin access over all organisations and users. Available in Grafana v5.3 and above | `false` `grafana_admin` | No | When `true` makes user of `group_dn` Grafana server admin. A Grafana server admin has admin access over all organizations and users. Available in Grafana v5.3 and above | `false`
### Nested/recursive group membership ### Nested/recursive group membership
......
+++ +++
title = "Contributor Licence Agreement (CLA)" title = "Contributor License Agreement (CLA)"
description = "Contributor Licence Agreement (CLA)" description = "Contributor License Agreement (CLA)"
type = "docs" type = "docs"
aliases = ["/project/cla", "docs/contributing/cla.html"] aliases = ["/project/cla", "docs/contributing/cla.html"]
[menu.docs] [menu.docs]
......
...@@ -31,7 +31,7 @@ Datasource permissions allow you to restrict query access to only specific Teams ...@@ -31,7 +31,7 @@ Datasource permissions allow you to restrict query access to only specific Teams
### Premium Plugins ### Premium Plugins
With a Grafana Enterprise licence you will get access to premium plugins, including: With a Grafana Enterprise license you will get access to premium plugins, including:
* [Splunk](https://grafana.com/plugins/grafana-splunk-datasource) * [Splunk](https://grafana.com/plugins/grafana-splunk-datasource)
* [AppDynamics](https://grafana.com/plugins/dlopes7-appdynamics-datasource) * [AppDynamics](https://grafana.com/plugins/dlopes7-appdynamics-datasource)
......
...@@ -134,7 +134,7 @@ continue work on a `build mode` for a future release. ...@@ -134,7 +134,7 @@ continue work on a `build mode` for a future release.
The new row menu automatically slides out when you mouse over the edge of the row. You no longer need The new row menu automatically slides out when you mouse over the edge of the row. You no longer need
to hover over the small green icon and then click it to expand the row menu. to hover over the small green icon and then click it to expand the row menu.
There are some minor improvements to drag and drop behaviour. Now when dragging a panel from one row There are some minor improvements to drag and drop behavior. Now when dragging a panel from one row
to another you will insert the panel and Grafana will automatically make room for it. to another you will insert the panel and Grafana will automatically make room for it.
When you drag a panel within a row you will simply reorder the panels. When you drag a panel within a row you will simply reorder the panels.
......
...@@ -26,7 +26,7 @@ dashboards, creating users and updating data sources. ...@@ -26,7 +26,7 @@ dashboards, creating users and updating data sources.
* [Folder Permissions API]({{< relref "http_api/folder_permissions.md" >}}) * [Folder Permissions API]({{< relref "http_api/folder_permissions.md" >}})
* [Folder/dashboard search API]({{< relref "/http_api/folder_dashboard_search.md" >}}) * [Folder/dashboard search API]({{< relref "/http_api/folder_dashboard_search.md" >}})
* [Data Source API]({{< relref "http_api/data_source.md" >}}) * [Data Source API]({{< relref "http_api/data_source.md" >}})
* [Organisation API]({{< relref "http_api/org.md" >}}) * [Organization API]({{< relref "http_api/org.md" >}})
* [Snapshot API]({{< relref "http_api/snapshot.md" >}}) * [Snapshot API]({{< relref "http_api/snapshot.md" >}})
* [Annotations API]({{< relref "http_api/annotations.md" >}}) * [Annotations API]({{< relref "http_api/annotations.md" >}})
* [Alerting API]({{< relref "http_api/alerting.md" >}}) * [Alerting API]({{< relref "http_api/alerting.md" >}})
......
+++ +++
title = "Organisation HTTP API " title = "Organization HTTP API "
description = "Grafana Organisation HTTP API" description = "Grafana Organization HTTP API"
keywords = ["grafana", "http", "documentation", "api", "organisation"] keywords = ["grafana", "http", "documentation", "api", "organization"]
aliases = ["/http_api/organisation/"] aliases = ["/http_api/organization/"]
type = "docs" type = "docs"
[menu.docs] [menu.docs]
name = "Organisation" name = "Organization"
parent = "http_api" parent = "http_api"
+++ +++
# Organisation API # Organization API
The Organisation HTTP API is divided in two resources, `/api/org` (current organisation) The Organization HTTP API is divided in two resources, `/api/org` (current organization)
and `/api/orgs` (admin organisations). One big difference between these are that and `/api/orgs` (admin organizations). One big difference between these are that
the admin of all organisations API only works with basic authentication, see [Admin Organisations API](#admin-organisations-api) for more information. the admin of all organizations API only works with basic authentication, see [Admin Organizations API](#admin-organizations-api) for more information.
## Current Organisation API ## Current Organization API
### Get current Organisation ### Get current Organization
`GET /api/org/` `GET /api/org/`
...@@ -43,7 +43,7 @@ Content-Type: application/json ...@@ -43,7 +43,7 @@ Content-Type: application/json
} }
``` ```
### Get all users within the current organisation ### Get all users within the current organization
`GET /api/org/users` `GET /api/org/users`
...@@ -99,7 +99,7 @@ Content-Type: application/json ...@@ -99,7 +99,7 @@ Content-Type: application/json
{"message":"Organization user updated"} {"message":"Organization user updated"}
``` ```
### Delete user in current organisation ### Delete user in current organization
`DELETE /api/org/users/:userId` `DELETE /api/org/users/:userId`
...@@ -121,7 +121,7 @@ Content-Type: application/json ...@@ -121,7 +121,7 @@ Content-Type: application/json
{"message":"User removed from organization"} {"message":"User removed from organization"}
``` ```
### Update current Organisation ### Update current Organization
`PUT /api/org` `PUT /api/org`
...@@ -147,11 +147,11 @@ Content-Type: application/json ...@@ -147,11 +147,11 @@ Content-Type: application/json
{"message":"Organization updated"} {"message":"Organization updated"}
``` ```
### Add a new user to the current organisation ### Add a new user to the current organization
`POST /api/org/users` `POST /api/org/users`
Adds a global user to the current organisation. Adds a global user to the current organization.
**Example Request**: **Example Request**:
...@@ -176,19 +176,19 @@ Content-Type: application/json ...@@ -176,19 +176,19 @@ Content-Type: application/json
{"message":"User added to organization"} {"message":"User added to organization"}
``` ```
## Admin Organisations API ## Admin Organizations API
The Admin Organisations HTTP API does not currently work with an API Token. API Tokens are currently The Admin Organizations HTTP API does not currently work with an API Token. API Tokens are currently
only linked to an organization and an organization role. They cannot be given the permission of server only linked to an organization and an organization role. They cannot be given the permission of server
admin, only users can be given that permission. So in order to use these API calls you will have to admin, only users can be given that permission. So in order to use these API calls you will have to
use Basic Auth and the Grafana user must have the Grafana Admin permission (The default admin user use Basic Auth and the Grafana user must have the Grafana Admin permission (The default admin user
is called `admin` and has permission to use this API). is called `admin` and has permission to use this API).
### Get Organisation by Id ### Get Organization by Id
`GET /api/orgs/:orgId` `GET /api/orgs/:orgId`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api). Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: **Example Request**:
...@@ -217,11 +217,11 @@ Content-Type: application/json ...@@ -217,11 +217,11 @@ Content-Type: application/json
} }
} }
``` ```
### Get Organisation by Name ### Get Organization by Name
`GET /api/orgs/name/:orgName` `GET /api/orgs/name/:orgName`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api). Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: **Example Request**:
...@@ -251,11 +251,11 @@ Content-Type: application/json ...@@ -251,11 +251,11 @@ Content-Type: application/json
} }
``` ```
### Create Organisation ### Create Organization
`POST /api/orgs` `POST /api/orgs`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api). Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: **Example Request**:
...@@ -284,11 +284,11 @@ Content-Type: application/json ...@@ -284,11 +284,11 @@ Content-Type: application/json
} }
``` ```
### Search all Organisations ### Search all Organizations
`GET /api/orgs` `GET /api/orgs`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api). Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: **Example Request**:
...@@ -314,12 +314,12 @@ Content-Type: application/json ...@@ -314,12 +314,12 @@ Content-Type: application/json
] ]
``` ```
### Update Organisation ### Update Organization
`PUT /api/orgs/:orgId` `PUT /api/orgs/:orgId`
Update Organisation, fields *Address 1*, *Address 2*, *City* are not implemented yet. Update Organization, fields *Address 1*, *Address 2*, *City* are not implemented yet.
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api). Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: **Example Request**:
...@@ -342,11 +342,11 @@ Content-Type: application/json ...@@ -342,11 +342,11 @@ Content-Type: application/json
{"message":"Organization updated"} {"message":"Organization updated"}
``` ```
### Delete Organisation ### Delete Organization
`DELETE /api/orgs/:orgId` `DELETE /api/orgs/:orgId`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api). Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: **Example Request**:
...@@ -364,11 +364,11 @@ Content-Type: application/json ...@@ -364,11 +364,11 @@ Content-Type: application/json
{"message":"Organization deleted"} {"message":"Organization deleted"}
``` ```
### Get Users in Organisation ### Get Users in Organization
`GET /api/orgs/:orgId/users` `GET /api/orgs/:orgId/users`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api). Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: **Example Request**:
...@@ -397,11 +397,11 @@ Content-Type: application/json ...@@ -397,11 +397,11 @@ Content-Type: application/json
] ]
``` ```
### Add User in Organisation ### Add User in Organization
`POST /api/orgs/:orgId/users` `POST /api/orgs/:orgId/users`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api). Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: **Example Request**:
...@@ -425,11 +425,11 @@ Content-Type: application/json ...@@ -425,11 +425,11 @@ Content-Type: application/json
{"message":"User added to organization"} {"message":"User added to organization"}
``` ```
### Update Users in Organisation ### Update Users in Organization
`PATCH /api/orgs/:orgId/users/:userId` `PATCH /api/orgs/:orgId/users/:userId`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api). Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: **Example Request**:
...@@ -452,11 +452,11 @@ Content-Type: application/json ...@@ -452,11 +452,11 @@ Content-Type: application/json
{"message":"Organization user updated"} {"message":"Organization user updated"}
``` ```
### Delete User in Organisation ### Delete User in Organization
`DELETE /api/orgs/:orgId/users/:userId` `DELETE /api/orgs/:orgId/users/:userId`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api). Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: **Example Request**:
......
...@@ -196,7 +196,7 @@ Content-Type: application/json ...@@ -196,7 +196,7 @@ Content-Type: application/json
{"message":"User updated"} {"message":"User updated"}
``` ```
## Get Organisations for user ## Get Organizations for user
`GET /api/users/:id/orgs` `GET /api/users/:id/orgs`
...@@ -367,11 +367,11 @@ Content-Type: application/json ...@@ -367,11 +367,11 @@ Content-Type: application/json
{"message":"Active organization changed"} {"message":"Active organization changed"}
``` ```
## Organisations of the actual User ## Organizations of the actual User
`GET /api/user/orgs` `GET /api/user/orgs`
Return a list of all organisations of the current user. Return a list of all organizations of the current user.
**Example Request**: **Example Request**:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment