Add support for specific per-schema corrections

Author: jlevers

resources/schema-corrections.json

@@ -0,0 +1,26 @@
+{
+  "us": {
+    "mp": {
+      "items": {
+        "paths": {
+          "\/v3\/items\/{id}": {
+            "get": {
+              "responses": {
+                "200": {
+                  "content": {
+                    "application\/json": {
+                      "schema": {
+                        "$ref": "#\/components\/schemas\/ItemResponses"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "schemas": {}
+      }
+    }
+  }
+}

utils/constants.php

@@ -13,6 +13,7 @@
 const DEFAULT_MODEL_DIR = 'Model';
 
 const LOGFILE = __DIR__ . '/../generate.log';
+const SCHEMA_FIXES_FILE = RESOURCE_DIR . '/schema-corrections.json';
 
 const BASIC_SCHEME_HEADER = 'Authorization';
 const ACCESS_TOKEN_HEADER = 'WM_SEC.ACCESS_TOKEN';

utils/customize-schemas.php

@@ -12,11 +12,18 @@
  *
  * @param string $path The path to the schema file
  * @param string $category The category code for the schema
- * @param string $name The human-readable API name for the schema
+ * @param string $country The country code for the schema
+ * @param string $apiCode The internal API code for the schema
+ * @param string $apiName The human-readable API name for the schema
  * @return void
  */
-function customizeSchema(string $path, string $category, string $name): void
-{
+function customizeSchema(
+    string $path,
+    string $category,
+    string $country,
+    string $apiCode,
+    string $apiName
+): void {
     // There are auth headers that are the same on (nearly) every request, but which Walmart includes in every
     // single request schema. We remove them so that the SDK is easier to use, and will pass them in during the
     // request signing process when an endpoint is called.
@@ -78,7 +85,7 @@ function customizeSchema(string $path, string $category, string $name): void
             $security = [];
 
             // Standardize tags based on our internal naming convention (derived from resources/apis.json)
-            $verb['tags'] = [$name];
+            $verb['tags'] = [$apiName];
 
             // Update each operation's parameters and auth information
             foreach ($verb['parameters'] as $i => $parameter) {    
@@ -176,6 +183,8 @@ function customizeSchema(string $path, string $category, string $name): void
         $schema['components']['schemas'] = replaceComponentInlineSchemas($componentSchemas);
     }
 
+    $schema = fixSchema($schema, $country, $category, $apiCode);
+
     file_put_contents($path, json_encode($schema, JSON_PRETTY_PRINT));
 }
 
@@ -345,14 +354,43 @@ function chooseContentType(array $content): string
     return array_key_first($content);
 }
 
+/**
+ * Applies specific model fixes from the resources/schema-corrections.json file to the current schema.
+ *
+ * @param array $schema The schema to apply the fixes to
+ * @param string $country The country code for the schema
+ * @param string $category The category code for the schema
+ * @param string $code The internal API code for the schema
+ */
+function fixSchema(array $schema, string $country, string $category, string $code): array
+{
+    $allFixes = json_decode(file_get_contents(SCHEMA_FIXES_FILE), true);
+    $fixes = $allFixes[$country][$category][$code] ?? [];
+
+    if (isset($fixes['paths'])) {
+        $schema['paths'] = array_merge_recursive_distinct(
+            $schema['paths'],
+            $fixes['paths']
+        );
+    }
+
+    return $schema;
+}
+
 /**
  * Prepares schemas for api/model generation using janephp.
  */
 function customizeSchemas(array $categories, array $countries, array $apiCodes): void
 {
     $schemas = schemas($categories, $countries, $apiCodes);
     foreach ($schemas as $schemaInfo) {
-        customizeSchema($schemaInfo['path'], $schemaInfo['category'], $schemaInfo['api']['name']);
+        customizeSchema(
+            $schemaInfo['path'],
+            $schemaInfo['category'],
+            $schemaInfo['country'],
+            $schemaInfo['api']['code'],
+            $schemaInfo['api']['name'],
+        );
     }
 }
 

utils/helpers.php

@@ -138,10 +138,38 @@ function handleSchemaOpts(): array
     ];
 }
 
-// Get the library version
+/**
+ * Get the current version code for the library.
+ *
+ * @return string 
+ */
 function libVersion(): string
 {
     $configPath = RESOURCE_DIR . '/generator-config.json';
     $config = json_decode(file_get_contents($configPath), true);
     return $config['artifactVersion'];
 }
+
+/**
+ * Merge two arrays recursively, overwriting keys in the first array with keys from the second array.
+ * Poached from https://www.php.net/manual/en/function.array-merge-recursive.php#92195
+ *
+ * @param array $array1 
+ * @param array $array2 
+ * @return array 
+ */
+function array_merge_recursive_distinct(array &$array1, array &$array2): array
+{
+  $merged = $array1;
+
+  foreach ($array2 as $key => &$value)
+  {
+    if (is_array($value) && isset($merged[$key]) && is_array($merged[$key])) {
+      $merged[$key] = array_merge_recursive_distinct($merged[$key], $value);
+    } else {
+      $merged [$key] = $value;
+    }
+  }
+
+  return $merged;
+}