ENG-2805 Fix id usage and fix patchAPIKey.json

src/main/api/deactivateUsers.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/user/bulk",
   "comments": [
-    "Deactivates the users with the given ids."
+    "Deactivates the users with the given Ids."
   ],
   "deprecated": "This method has been renamed to {{renamedMethod}}, use that method instead.",
   "renamedMethod": "deactivateUsersByIds",
@@ -34,4 +34,4 @@
       "value": "false"
     }
   ]
-}
+}

src/main/api/deactivateUsersByIds.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/user/bulk",
   "comments": [
-    "Deactivates the users with the given ids."
+    "Deactivates the users with the given Ids."
   ],
   "method": "delete",
   "methodName": "deactivateUsersByIds",
@@ -32,4 +32,4 @@
       "value": "false"
     }
   ]
-}
+}

src/main/api/deleteUsers.json

@@ -1,8 +1,8 @@
 {
   "uri": "/api/user/bulk",
   "comments": [
-    "Deletes the users with the given ids, or users matching the provided JSON query or queryString.",
-    "The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.",
+    "Deletes the users with the given Ids, or users matching the provided JSON query or queryString.",
+    "The order of preference is Ids, query and then queryString, it is recommended to only provide one of the three for the request.",
     "",
     "This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.",
     "Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users."
@@ -23,4 +23,4 @@
       "javaType": "UserDeleteRequest"
     }
   ]
-}
+}

src/main/api/deleteUsersByQuery.json

@@ -1,8 +1,8 @@
 {
   "uri": "/api/user/bulk",
   "comments": [
-    "Deletes the users with the given ids, or users matching the provided JSON query or queryString.",
-    "The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.",
+    "Deletes the users with the given Ids, or users matching the provided JSON query or queryString.",
+    "The order of preference is Ids, query and then queryString, it is recommended to only provide one of the three for the request.",
     "",
     "This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.",
     "Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users."
@@ -21,4 +21,4 @@
       "javaType": "UserDeleteRequest"
     }
   ]
-}
+}

src/main/api/modifyAction.json

@@ -12,7 +12,7 @@
     {
       "name": "actionId",
       "comments": [
-        "The Id of the action to modify. This is technically the user action log id."
+        "The Id of the action to modify. This is technically the user action log Id."
       ],
       "type": "urlSegment",
       "javaType": "UUID"

src/main/api/patchAPIKey.json

@@ -1,25 +1,25 @@
 {
   "uri": "/api/api-key",
   "comments": [
-        "Updates an authentication API key by given id"
+    "Updates an API key with the given Id."
   ],
-  "method": "post",
+  "method": "patch",
   "methodName": "patchAPIKey",
   "successResponse": "APIKeyResponse",
   "errorResponse": "Errors",
   "params": [
     {
       "name": "keyId",
       "comments": [
-        "The Id of the authentication key. If not provided a secure random api key will be generated."
+        "The Id of the API key. If not provided a secure random api key will be generated."
       ],
       "type": "urlSegment",
       "javaType": "UUID"
     },
     {
       "name": "request",
       "comments": [
-        "The request object that contains all the information needed to create the APIKey."
+        "The request object that contains all the information needed to create the API key."
       ],
       "type": "body",
       "javaType": "APIKeyRequest"

src/main/api/removeUserFromFamily.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/user/family",
   "comments": [
-    "Removes a user from the family with the given id."
+    "Removes a user from the family with the given Id."
   ],
   "method": "delete",
   "methodName": "removeUserFromFamily",

src/main/api/retrieveAPIKey.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/api-key",
   "comments": [
-    "Retrieves an authentication API key for the given id"
+    "Retrieves an authentication API key for the given Id."
   ],
   "method": "get",
   "methodName": "retrieveAPIKey",
@@ -17,4 +17,4 @@
       "javaType": "UUID"
     }
   ]
-}
+}

src/main/api/retrieveApplication.json

@@ -11,7 +11,7 @@
     {
       "name": "applicationId",
       "comments": [
-        "(Optional) The application id."
+        "(Optional) The application Id."
       ],
       "type": "urlSegment",
       "javaType": "UUID"

src/main/api/retrieveDailyActiveReport.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/report/daily-active-user",
   "comments": [
-    "Retrieves the daily active user report between the two instants. If you specify an application id, it will only",
+    "Retrieves the daily active user report between the two instants. If you specify an application Id, it will only",
     "return the daily active counts for that application."
   ],
   "method": "get",
@@ -12,7 +12,7 @@
     {
       "name": "applicationId",
       "comments": [
-        "(Optional) The application id."
+        "(Optional) The application Id."
       ],
       "type": "urlParameter",
       "parameterName": "applicationId",
@@ -37,4 +37,4 @@
       "javaType": "long"
     }
   ]
-}
+}

src/main/api/retrieveEmailTemplate.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/email/template",
   "comments": [
-    "Retrieves the email template for the given Id. If you don't specify the id, this will return all the email templates."
+    "Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates."
   ],
   "method": "get",
   "methodName": "retrieveEmailTemplate",

src/main/api/retrieveLoginReport.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/report/login",
   "comments": [
-    "Retrieves the login report between the two instants. If you specify an application id, it will only return the",
+    "Retrieves the login report between the two instants. If you specify an application Id, it will only return the",
     "login counts for that application."
   ],
   "method": "get",
@@ -12,7 +12,7 @@
     {
       "name": "applicationId",
       "comments": [
-        "(Optional) The application id."
+        "(Optional) The application Id."
       ],
       "type": "urlParameter",
       "parameterName": "applicationId",
@@ -37,4 +37,4 @@
       "javaType": "long"
     }
   ]
-}
+}

src/main/api/retrieveMessageTemplate.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/message/template",
   "comments": [
-    "Retrieves the message template for the given Id. If you don't specify the id, this will return all the message templates."
+    "Retrieves the message template for the given Id. If you don't specify the Id, this will return all the message templates."
   ],
   "method": "get",
   "methodName": "retrieveMessageTemplate",

src/main/api/retrieveMonthlyActiveReport.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/report/monthly-active-user",
   "comments": [
-    "Retrieves the monthly active user report between the two instants. If you specify an application id, it will only",
+    "Retrieves the monthly active user report between the two instants. If you specify an application Id, it will only",
     "return the monthly active counts for that application."
   ],
   "method": "get",
@@ -12,7 +12,7 @@
     {
       "name": "applicationId",
       "comments": [
-        "(Optional) The application id."
+        "(Optional) The application Id."
       ],
       "type": "urlParameter",
       "parameterName": "applicationId",
@@ -37,4 +37,4 @@
       "javaType": "long"
     }
   ]
-}
+}

src/main/api/retrieveRegistration.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/user/registration",
   "comments": [
-    "Retrieves the user registration for the user with the given Id and the given application id."
+    "Retrieves the user registration for the user with the given Id and the given application Id."
   ],
   "method": "get",
   "methodName": "retrieveRegistration",

src/main/api/retrieveRegistrationReport.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/report/registration",
   "comments": [
-    "Retrieves the registration report between the two instants. If you specify an application id, it will only return",
+    "Retrieves the registration report between the two instants. If you specify an application Id, it will only return",
     "the registration counts for that application."
   ],
   "method": "get",
@@ -12,7 +12,7 @@
     {
       "name": "applicationId",
       "comments": [
-        "(Optional) The application id."
+        "(Optional) The application Id."
       ],
       "type": "urlParameter",
       "parameterName": "applicationId",
@@ -37,4 +37,4 @@
       "javaType": "long"
     }
   ]
-}
+}

src/main/api/retrieveUserAction.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/user-action",
   "comments": [
-    "Retrieves the user action for the given Id. If you pass in null for the id, this will return all the user",
+    "Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user",
     "actions."
   ],
   "method": "get",

src/main/api/retrieveUserActionReason.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/user-action-reason",
   "comments": [
-    "Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all the user",
+    "Retrieves the user action reason for the given Id. If you pass in null for the Id, this will return all the user",
     "action reasons."
   ],
   "method": "get",

src/main/api/retrieveUserCode.json

@@ -14,7 +14,7 @@
     {
       "name": "client_id",
       "comments": [
-        "The client id."
+        "The client Id."
       ],
       "type": "form",
       "parameterName": "client_id",
@@ -23,7 +23,7 @@
     {
       "name": "client_secret",
       "comments": [
-        "The client id."
+        "The client Id."
       ],
       "type": "form",
       "parameterName": "client_secret",

src/main/api/retrieveUserLoginReport.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/report/login",
   "comments": [
-    "Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the",
+    "Retrieves the login report between the two instants for a particular user by Id. If you specify an application Id, it will only return the",
     "login counts for that application."
   ],
   "method": "get",
@@ -12,7 +12,7 @@
     {
       "name": "applicationId",
       "comments": [
-        "(Optional) The application id."
+        "(Optional) The application Id."
       ],
       "type": "urlParameter",
       "parameterName": "applicationId",
@@ -21,7 +21,7 @@
     {
       "name": "userId",
       "comments": [
-        "The userId id."
+        "The userId Id."
       ],
       "type": "urlParameter",
       "parameterName": "userId",
@@ -46,4 +46,4 @@
       "javaType": "long"
     }
   ]
-}
+}

src/main/api/retrieveUserLoginReportByLoginId.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/report/login",
   "comments": [
-    "Retrieves the login report between the two instants for a particular user by login Id. If you specify an application id, it will only return the",
+    "Retrieves the login report between the two instants for a particular user by login Id. If you specify an application Id, it will only return the",
     "login counts for that application."
   ],
   "method": "get",
@@ -12,7 +12,7 @@
     {
       "name": "applicationId",
       "comments": [
-        "(Optional) The application id."
+        "(Optional) The application Id."
       ],
       "type": "urlParameter",
       "parameterName": "applicationId",
@@ -21,7 +21,7 @@
     {
       "name": "loginId",
       "comments": [
-        "The userId id."
+        "The userId Id."
       ],
       "type": "urlParameter",
       "parameterName": "loginId",
@@ -46,4 +46,4 @@
       "javaType": "long"
     }
   ]
-}
+}

src/main/api/retrieveWebhook.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/webhook",
   "comments": [
-    "Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks."
+    "Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks."
   ],
   "method": "get",
   "methodName": "retrieveWebhook",
@@ -17,4 +17,4 @@
       "javaType": "UUID"
     }
   ]
-}
+}

src/main/api/searchEntitiesByIds.json

@@ -1,7 +1,7 @@
 {
   "uri": "/api/entity/search",
   "comments": [
-    "Retrieves the entities for the given ids. If any Id is invalid, it is ignored."
+    "Retrieves the entities for the given Ids. If any Id is invalid, it is ignored."
   ],
   "method": "get",
   "methodName": "searchEntitiesByIds",