From e9aa927776a2c1b11805f6651f6edb9e4da1270c Mon Sep 17 00:00:00 2001 From: Michael Beemer Date: Fri, 26 Jul 2024 11:32:47 -0400 Subject: [PATCH] add optional targeting key property Signed-off-by: Michael Beemer --- service/openapi.yaml | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/service/openapi.yaml b/service/openapi.yaml index 865e02b..d7ee822 100644 --- a/service/openapi.yaml +++ b/service/openapi.yaml @@ -29,7 +29,7 @@ paths: tags: [OFREP core] summary: OFREP single flag evaluation contract description: | - OFREP single flag evaluation request. + OFREP single flag evaluation request. The endpoint is called by the server providers to perform single flag evaluation. parameters: - name: key @@ -86,8 +86,8 @@ paths: tags: [OFREP core] summary: OFREP bulk flag evaluation contract description: | - OFREP bulk evaluation request. - The endpoint is called by the client providers to perform single flag evaluation. + OFREP bulk evaluation request. + The endpoint is called by the client providers to evaluate all flags at once. parameters: - in: header name: If-None-Match @@ -145,7 +145,7 @@ paths: tags: [OFREP extensions] summary: OFREP provider configuration description: | - OFREP configuration is used to supply information about the remote flag management system and to set up the OpenFeature SDK providers. + OFREP configuration is used to supply information about the remote flag management system and to set up the OpenFeature SDK providers. The providers will contact this endpoint only if the client has opted in. parameters: - in: header @@ -290,6 +290,13 @@ components: context: type: object description: Context information for flag evaluation + properties: + targetingKey: + type: string + description: A string logically identifying the subject of evaluation (end-user, service, etc). + examples: + - user-123 + additionalProperties: true booleanFlag: description: A boolean typed flag value properties: