From 3014a86f9626736d79d30509d3f1372c5ce19acd Mon Sep 17 00:00:00 2001 From: Ewan Harris Date: Wed, 17 Jul 2024 10:26:11 +0200 Subject: [PATCH] doc: correct consistency reference in doc string (#182) * doc: correct consistency reference in doc string * chore: remove dx from codeowners as we're moving off feature branch --- .github/CODEOWNERS | 2 +- docs/openapiv2/apidocs.swagger.json | 2 +- openfga/v1/openfga_service.proto | 2 +- proto/openfga/v1/openfga_service.pb.go | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 495bdc9d..ad1a5588 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,2 +1,2 @@ -* @openfga/backend @openfga/dx +* @openfga/backend docs/ @openfga/dx @openfga/docs \ No newline at end of file diff --git a/docs/openapiv2/apidocs.swagger.json b/docs/openapiv2/apidocs.swagger.json index 2153c00a..8991726f 100644 --- a/docs/openapiv2/apidocs.swagger.json +++ b/docs/openapiv2/apidocs.swagger.json @@ -1699,7 +1699,7 @@ "HIGHER_CONSISTENCY" ], "default": "UNSPECIFIED", - "description": "- UNSPECIFIED: Default if not set. Behavior will be the same as MINIMIZE_LATENCY\n - MINIMIZE_LATENCY: Minimize latency at the potential expense of higher consistency.\n - HIGHER_CONSISTENCY: Prefer higher consistency, at the potential expense of increased latency.", + "description": "- UNSPECIFIED: Default if not set. Behavior will be the same as MINIMIZE_LATENCY\n - MINIMIZE_LATENCY: Minimize latency at the potential expense of lower consistency.\n - HIGHER_CONSISTENCY: Prefer higher consistency, at the potential expense of increased latency.", "title": "Controls the consistency preferences when calling the query APIs.\nbuf:lint:ignore ENUM_ZERO_VALUE_SUFFIX\nbuf:lint:ignore ENUM_VALUE_PREFIX" }, "ContextualTupleKeys": { diff --git a/openfga/v1/openfga_service.proto b/openfga/v1/openfga_service.proto index a1c1984d..87b18b6a 100644 --- a/openfga/v1/openfga_service.proto +++ b/openfga/v1/openfga_service.proto @@ -780,7 +780,7 @@ service OpenFGAService { enum ConsistencyPreference { // Default if not set. Behavior will be the same as MINIMIZE_LATENCY UNSPECIFIED = 0; - // Minimize latency at the potential expense of higher consistency. + // Minimize latency at the potential expense of lower consistency. MINIMIZE_LATENCY = 100; // Prefer higher consistency, at the potential expense of increased latency. HIGHER_CONSISTENCY = 200; diff --git a/proto/openfga/v1/openfga_service.pb.go b/proto/openfga/v1/openfga_service.pb.go index 9f0b34a8..38c21bc8 100644 --- a/proto/openfga/v1/openfga_service.pb.go +++ b/proto/openfga/v1/openfga_service.pb.go @@ -35,7 +35,7 @@ type ConsistencyPreference int32 const ( // Default if not set. Behavior will be the same as MINIMIZE_LATENCY ConsistencyPreference_UNSPECIFIED ConsistencyPreference = 0 - // Minimize latency at the potential expense of higher consistency. + // Minimize latency at the potential expense of lower consistency. ConsistencyPreference_MINIMIZE_LATENCY ConsistencyPreference = 100 // Prefer higher consistency, at the potential expense of increased latency. ConsistencyPreference_HIGHER_CONSISTENCY ConsistencyPreference = 200