Skip to content

Commit a771e9e

Browse files
authored
ENG-2805 Fix id usage and fix patchAPIKey.json (#154)
* id -> Id, and fix patchAPIKey.json * sync up domainNG * add a variable copyright year
1 parent 80d4fbf commit a771e9e

47 files changed

Lines changed: 88 additions & 78 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/main/api/deactivateUsers.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"uri": "/api/user/bulk",
33
"comments": [
4-
"Deactivates the users with the given ids."
4+
"Deactivates the users with the given Ids."
55
],
66
"deprecated": "This method has been renamed to {{renamedMethod}}, use that method instead.",
77
"renamedMethod": "deactivateUsersByIds",
@@ -34,4 +34,4 @@
3434
"value": "false"
3535
}
3636
]
37-
}
37+
}

src/main/api/deactivateUsersByIds.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"uri": "/api/user/bulk",
33
"comments": [
4-
"Deactivates the users with the given ids."
4+
"Deactivates the users with the given Ids."
55
],
66
"method": "delete",
77
"methodName": "deactivateUsersByIds",
@@ -32,4 +32,4 @@
3232
"value": "false"
3333
}
3434
]
35-
}
35+
}

src/main/api/deleteUsers.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"uri": "/api/user/bulk",
33
"comments": [
4-
"Deletes the users with the given ids, or users matching the provided JSON query or queryString.",
5-
"The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.",
4+
"Deletes the users with the given Ids, or users matching the provided JSON query or queryString.",
5+
"The order of preference is Ids, query and then queryString, it is recommended to only provide one of the three for the request.",
66
"",
77
"This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.",
88
"Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users."
@@ -23,4 +23,4 @@
2323
"javaType": "UserDeleteRequest"
2424
}
2525
]
26-
}
26+
}

src/main/api/deleteUsersByQuery.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"uri": "/api/user/bulk",
33
"comments": [
4-
"Deletes the users with the given ids, or users matching the provided JSON query or queryString.",
5-
"The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.",
4+
"Deletes the users with the given Ids, or users matching the provided JSON query or queryString.",
5+
"The order of preference is Ids, query and then queryString, it is recommended to only provide one of the three for the request.",
66
"",
77
"This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.",
88
"Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users."
@@ -21,4 +21,4 @@
2121
"javaType": "UserDeleteRequest"
2222
}
2323
]
24-
}
24+
}

src/main/api/modifyAction.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
{
1313
"name": "actionId",
1414
"comments": [
15-
"The Id of the action to modify. This is technically the user action log id."
15+
"The Id of the action to modify. This is technically the user action log Id."
1616
],
1717
"type": "urlSegment",
1818
"javaType": "UUID"

src/main/api/patchAPIKey.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
{
22
"uri": "/api/api-key",
33
"comments": [
4-
"Updates an authentication API key by given id"
4+
"Updates an API key with the given Id."
55
],
6-
"method": "post",
6+
"method": "patch",
77
"methodName": "patchAPIKey",
88
"successResponse": "APIKeyResponse",
99
"errorResponse": "Errors",
1010
"params": [
1111
{
1212
"name": "keyId",
1313
"comments": [
14-
"The Id of the authentication key. If not provided a secure random api key will be generated."
14+
"The Id of the API key. If not provided a secure random api key will be generated."
1515
],
1616
"type": "urlSegment",
1717
"javaType": "UUID"
1818
},
1919
{
2020
"name": "request",
2121
"comments": [
22-
"The request object that contains all the information needed to create the APIKey."
22+
"The request object that contains all the information needed to create the API key."
2323
],
2424
"type": "body",
2525
"javaType": "APIKeyRequest"

src/main/api/removeUserFromFamily.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"uri": "/api/user/family",
33
"comments": [
4-
"Removes a user from the family with the given id."
4+
"Removes a user from the family with the given Id."
55
],
66
"method": "delete",
77
"methodName": "removeUserFromFamily",

src/main/api/retrieveAPIKey.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"uri": "/api/api-key",
33
"comments": [
4-
"Retrieves an authentication API key for the given id"
4+
"Retrieves an authentication API key for the given Id."
55
],
66
"method": "get",
77
"methodName": "retrieveAPIKey",
@@ -17,4 +17,4 @@
1717
"javaType": "UUID"
1818
}
1919
]
20-
}
20+
}

src/main/api/retrieveApplication.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
{
1212
"name": "applicationId",
1313
"comments": [
14-
"(Optional) The application id."
14+
"(Optional) The application Id."
1515
],
1616
"type": "urlSegment",
1717
"javaType": "UUID"

src/main/api/retrieveDailyActiveReport.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"uri": "/api/report/daily-active-user",
33
"comments": [
4-
"Retrieves the daily active user report between the two instants. If you specify an application id, it will only",
4+
"Retrieves the daily active user report between the two instants. If you specify an application Id, it will only",
55
"return the daily active counts for that application."
66
],
77
"method": "get",
@@ -12,7 +12,7 @@
1212
{
1313
"name": "applicationId",
1414
"comments": [
15-
"(Optional) The application id."
15+
"(Optional) The application Id."
1616
],
1717
"type": "urlParameter",
1818
"parameterName": "applicationId",
@@ -37,4 +37,4 @@
3737
"javaType": "long"
3838
}
3939
]
40-
}
40+
}

0 commit comments

Comments
 (0)