use maj

Author: millotp

clients/algoliasearch-client-csharp/algoliasearch/Utils/ClientExtensions.cs

@@ -264,14 +264,14 @@ public static IEnumerable<SynonymHit> BrowseSynonyms(this SearchClient client, s
   /// Generate a virtual API Key without any call to the server.
   /// </summary>
   /// <param name="client"></param>
-  /// <param name="parentApiKey">Parent API Key</param>
+  /// <param name="parentAPIKey">Parent API Key</param>
   /// <param name="restriction">Restriction to add the key</param>
   /// <returns></returns>
-  public static string GenerateSecuredApiKey(this SearchClient client, string parentApiKey,
+  public static string GenerateSecuredApiKey(this SearchClient client, string parentAPIKey,
     SecuredAPIKeyRestrictions restriction)
   {
     var queryParams = restriction.ToQueryString();
-    var hash = HmacShaHelper.GetHash(parentApiKey, queryParams);
+    var hash = HmacShaHelper.GetHash(parentAPIKey, queryParams);
     return HmacShaHelper.Base64Encode($"{hash}{queryParams}");
   }
 

clients/algoliasearch-client-swift/Sources/Search/Extra/SearchHelpers.swift

@@ -440,15 +440,15 @@ public extension SearchClient {
     }
 
     /// Generate a secured API key
-    /// - parameter parentApiKey: The parent API key
+    /// - parameter parentAPIKey: The parent API key
     /// - parameter restriction: The restrictions
     /// - returns: String?
     func generateSecuredApiKey(
-        parentApiKey: String,
+        parentAPIKey: String,
         with restriction: SecuredAPIKeyRestrictions = SecuredAPIKeyRestrictions()
     ) throws -> String? {
         let queryParams = try restriction.toURLEncodedString()
-        let hash = queryParams.hmac256(withKey: parentApiKey)
+        let hash = queryParams.hmac256(withKey: parentAPIKey)
         return "\(hash)\(queryParams)".data(using: .utf8)?.base64EncodedString()
     }
 

templates/go/search_helpers.mustache

@@ -296,9 +296,9 @@ func (c *APIClient) WaitForApiKeyWithContext(
 
 // GenerateSecuredApiKey generates a public API key intended to restrict access
 // to certain records. This new key is built upon the existing key named
-// `parentApiKey` and the following options:
-func (c *APIClient) GenerateSecuredApiKey(parentApiKey string, restrictions *SecuredAPIKeyRestrictions) (string, error) {
-	h := hmac.New(sha256.New, []byte(parentApiKey))
+// `parentAPIKey` and the following options:
+func (c *APIClient) GenerateSecuredApiKey(parentAPIKey string, restrictions *SecuredAPIKeyRestrictions) (string, error) {
+	h := hmac.New(sha256.New, []byte(parentAPIKey))
 
 	message, err := encodeRestrictions(restrictions)
   if err != nil {

templates/javascript/clients/client/api/helpers.mustache

@@ -264,20 +264,20 @@ searchForFacets(
 },
 
 /**
- * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+ * Helper: Generates a secured API key based on the given `parentAPIKey` and given `restrictions`.
  *
- * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+ * @summary Helper: Generates a secured API key based on the given `parentAPIKey` and given `restrictions`.
  * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
- * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
+ * @param generateSecuredApiKey.parentAPIKey - The base API key from which to generate the new secured one.
  * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
  */
 generateSecuredApiKey({
-  parentApiKey,
+  parentAPIKey,
   restrictions = {},
 }: GenerateSecuredApiKeyOptions): string {
   const queryParameters = serializeQueryParameters(restrictions);
   return Buffer.from(
-    createHmac('sha256', parentApiKey)
+    createHmac('sha256', parentAPIKey)
       .update(queryParameters)
       .digest('hex') + queryParameters
   ).toString('base64');

templates/javascript/clients/client/model/clientMethodProps.mustache

@@ -104,7 +104,7 @@ export type GenerateSecuredApiKeyOptions = {
   /**
    * The base API key from which to generate the new secured one.
    */
-  parentApiKey: string;
+  parentAPIKey: string;
 
   /**
    * A set of properties defining the restrictions of the secured API key.

templates/javascript/tests/requests/helpers.mustache

@@ -1,14 +1,14 @@
 describe('generateSecuredApiKey', () => {
   test('generates a key without restrictions', () => {
-    const resp = client.generateSecuredApiKey({ parentApiKey: 'foo' });
+    const resp = client.generateSecuredApiKey({ parentAPIKey: 'foo' });
     expect(resp).toEqual(
       'NjgzNzE2ZDlkN2Y4MmVlZDE3NGM2Y2FlYmUwODZlZTkzMzc2Yzc5ZDdjNjFkZDY3MGVhMDBmN2Y4ZDZlYjBhOA=='
     );
   });
 
   test('generates a key with restrictions', () => {
     const resp = client.generateSecuredApiKey({
-      parentApiKey: 'foo',
+      parentAPIKey: 'foo',
       restrictions: {
         validUntil: 100,
         restrictIndices: ['bar'],
@@ -28,7 +28,7 @@ describe('generateSecuredApiKey', () => {
 describe('getSecuredApiKeyRemainingValidity', () => {
   test('is able to check the remaining validity of a key', () => {
     const resp = client.generateSecuredApiKey({
-      parentApiKey: 'foo',
+      parentAPIKey: 'foo',
       restrictions: { validUntil: 42 },
     });
     expect(resp).toEqual(
@@ -154,4 +154,4 @@ describe('replaceAllObjects', () => {
       moveOperationResponse: { taskID: 21, updatedAt: 'foobar' },
     });
   });
-});
+});

templates/php/api.mustache

@@ -498,12 +498,12 @@ use {{invokerPackage}}\Support\Helpers;
     /**
     * Helper: Generate a secured API Key.
     *
-    * @param string $parentApiKey Parent API Key
+    * @param string $parentAPIKey Parent API Key
     * @param array  $restrictions API Key's restrictions
     *
     * @return string
     */
-    public static function generateSecuredApiKey($parentApiKey, $restrictions)
+    public static function generateSecuredApiKey($parentAPIKey, $restrictions)
     {
         $formattedRestrictions = [];
 
@@ -525,7 +525,7 @@ use {{invokerPackage}}\Support\Helpers;
         $urlEncodedRestrictions = http_build_query($formattedRestrictions, encoding_type: PHP_QUERY_RFC3986);
 
 
-        $content = hash_hmac('sha256', $urlEncodedRestrictions, $parentApiKey).$urlEncodedRestrictions;
+        $content = hash_hmac('sha256', $urlEncodedRestrictions, $parentAPIKey).$urlEncodedRestrictions;
 
         return base64_encode($content);
     }

tests/output/swift/Tests/handwritten/SecuredAPIKeyHelpers.swift

@@ -15,7 +15,7 @@ class SecuredApiKeyHelpersTests: XCTestCase {
         let client = try SearchClient(appID: "my-app-id", apiKey: "my-api-key")
 
         let securedApiKey = try client.generateSecuredApiKey(
-            parentApiKey: "parent-api-key"
+            parentAPIKey: "parent-api-key"
         )
 
         guard let securedApiKey else {
@@ -35,7 +35,7 @@ class SecuredApiKeyHelpersTests: XCTestCase {
         let client = try SearchClient(appID: "my-app-id", apiKey: "my-api-key")
 
         let securedApiKey = try client.generateSecuredApiKey(
-            parentApiKey: "parent-api-key",
+            parentAPIKey: "parent-api-key",
             with: SecuredAPIKeyRestrictions(
                 searchParams: SearchParamsObject(hitsPerPage: 2),
                 validUntil: Int64(now + .seconds(13)),