You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by de...@apache.org on 2018/06/26 12:35:13 UTC
[trafficcontrol] branch master updated: Update profile_parameter.rst
This is an automated email from the ASF dual-hosted git repository.
dewrich pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 75ac91e Update profile_parameter.rst
75ac91e is described below
commit 75ac91efa937132a1198c9d7b561e2f94b015970
Author: Dan Kirkwood <da...@apache.org>
AuthorDate: Mon Jun 25 17:01:37 2018 -0600
Update profile_parameter.rst
---
docs/source/api/v12/profile_parameter.rst | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/docs/source/api/v12/profile_parameter.rst b/docs/source/api/v12/profile_parameter.rst
index e8534d9..8686ae0 100644
--- a/docs/source/api/v12/profile_parameter.rst
+++ b/docs/source/api/v12/profile_parameter.rst
@@ -33,7 +33,7 @@ Profile parameters
Role(s) Required: admin or oper
**Request Properties**
- This accept two formats: single profile-parameter, profile-parameter array.
+ This accepts two formats: single profile-parameter, profile-parameter array.
Single profile-parameter format:
@@ -177,12 +177,12 @@ Profile parameters
**POST /api/1.2/profiles/name/{:name}/parameters**
- Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
- If the profile does not exist, the API returns fail.
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter is already associated with the profile, keep the association.
+ If the profile does not exist, the API returns an error.
Authentication Required: Yes
- Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+ Role(s) Required: admin or oper. If the secure value is 1, the admin role is required.
**Request Route Parameters**
@@ -193,7 +193,7 @@ Profile parameters
+------------+----------+----------------------------------------------------+
**Request Properties**
- The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
+ The request properties accept 2 formats, both single parameter and parameters array formats are acceptable.
single parameter format:
@@ -227,12 +227,12 @@ Profile parameters
**Request Example** ::
- 1. single parameter format exampe:
+ 1. single parameter format example:
{
- "name":"param1",
+ "name":"param1",
"configFile":"configFile1",
"value":"value1",
- "secure":0,
+ "secure":0,
}
2. array format example:
@@ -308,7 +308,7 @@ Profile parameters
"alerts":[
{
"level": "success",
- "text": ""Assign parameters successfully to profile CCR1"
+ "text": "Assign parameters successfully to profile CCR1"
}
]
}
@@ -317,19 +317,19 @@ Profile parameters
**POST /api/1.2/profiles/id/{:id}/parameters**
- Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
- If the profile does not exist, the API returns fail.
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter is already associated with the profile, keep the association.
+ If the profile does not exist, the API returns an error.
Authentication Required: Yes
- Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+ Role(s) Required: admin or oper. If the secure value is 1, the admin role is required.
**Request Route Parameters**
+------------+----------+----------------------------------------------------+
| Name | Required | Description |
+============+==========+====================================================+
- | ``id`` | yes | profile name. |
+ | ``id`` | yes | profile id. |
+------------+----------+----------------------------------------------------+
**Request Properties**