fix: set a different example for ConsistencyPreference

openfga · Sep 4, 2024 · a89e7b2 · a89e7b2
1 parent 4fe6e93
commit a89e7b2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/openapiv2/apidocs.swagger.json b/docs/openapiv2/apidocs.swagger.json
diff --git a/scripts/update_swagger.sh b/scripts/update_swagger.sh
@@ -16,6 +16,12 @@ cat ${filename} | \
     'del(.paths[][]."responses"|select(has("400"))."default" ) | del(.paths[][]."responses"|select(has("201"))."200") | del(.paths[][]."responses"|select(has("204"))."200")' > ${tmp_filename}
 mv ${tmp_filename} ${filename}
 
+# Add an example value to the ConsistencyPreference to override the default of UNSPECIFIED being shown in the docs
+cat ${filename} | \
+  jq \
+    '.definitions.ConsistencyPreference.example = "MINIMIZE_LATENCY"' > ${tmp_filename}
+mv ${tmp_filename} ${filename}
+
 # Finally, for 204, there should be no schema
 cat ${filename} | \
   jq \