@@ -113,8 +113,7 @@ paths:
113113 schema :
114114 type : string
115115 format : date-time
116- examples :
117- - " 2024-02-07T12:00:00Z"
116+ example : " 2024-02-07T12:00:00Z"
118117 " 500 " :
119118 description : Internal Server Error. An unexpected error occurred on the server that prevented flag evaluation.
120119 content :
@@ -283,16 +282,11 @@ components:
283282 description : |
284283 An error code specific to the bulk evaluation error. See
285284 https://openfeature.dev/specification/types#error-code for error code definitions.
286- examples :
287- - INVALID_CONTEXT
288- - PARSE_ERROR
289- - GENERAL
285+ example : INVALID_CONTEXT
290286 errorDetails :
291287 type : string
292288 description : Optional error details description for logging or debugging purposes
293- examples :
294- - " Context is missing required targetingKey property"
295- - " Failed to parse evaluation request: invalid JSON"
289+ example : " Context is missing required targetingKey property"
296290 required :
297291 - errorCode
298292 evaluationRequest :
@@ -327,23 +321,11 @@ components:
327321 An OpenFeature reason code indicating why the flag was evaluated to this value.
328322 See https://openfeature.dev/specification/types/#resolution-reason for reason code definitions.
329323 enum : [STATIC, TARGETING_MATCH, SPLIT, DISABLED, UNKNOWN]
330- examples :
331- - STATIC
332- - TARGETING_MATCH
333- - SPLIT
334- - DISABLED
335- - UNKNOWN
336324 variant :
337325 type : string
338326 description : |
339327 Variant identifier for the evaluated feature flag value. Represents a specific variation
340328 or configuration of the feature flag.
341- examples :
342- - enabled
343- - disabled
344- - variant-a
345- - variant-b
346- - default
347329 metadata :
348330 allOf :
349331 - $ref : " #/components/schemas/metadata"
@@ -370,11 +352,6 @@ components:
370352 OpenFeature compatible error code indicating the type of error. See
371353 https://openfeature.dev/specification/types#error-code for error code definitions.
372354 enum : [PARSE_ERROR, TARGETING_KEY_MISSING, INVALID_CONTEXT, GENERAL]
373- examples :
374- - PARSE_ERROR
375- - TARGETING_KEY_MISSING
376- - INVALID_CONTEXT
377- - GENERAL
378355 errorDetails :
379356 $ref : " #/components/schemas/errorDetails"
380357 metadata :
@@ -398,8 +375,6 @@ components:
398375 type : string
399376 description : Error code indicating the flag was not found
400377 enum : [FLAG_NOT_FOUND]
401- examples :
402- - FLAG_NOT_FOUND
403378 errorDetails :
404379 $ref : " #/components/schemas/errorDetails"
405380 metadata :
@@ -423,11 +398,7 @@ components:
423398 description : |
424399 The unique identifier (key) of the feature flag. This is used to reference a specific
425400 flag in the flag management system.
426- examples :
427- - discount-banner
428- - new-checkout-flow
429- - experimental-feature
430- - theme-color
401+ example : discount-banner
431402 context :
432403 type : object
433404 description : |
@@ -440,11 +411,11 @@ components:
440411 targetingKey :
441412 type : string
442413 additionalProperties : true
443- examples :
444- - targetingKey : user-123
445- email : user@example.com
446- plan : premium
447- country : CA
414+ example :
415+ targetingKey : user-123
416+ email : user@example.com
417+ plan : premium
418+ country : CA
448419 booleanFlag :
449420 description : A boolean typed flag value. Used for simple on/off feature flags.
450421 type : object
@@ -514,13 +485,10 @@ components:
514485 - type : number
515486 flagMetadataExamples :
516487 description : Example metadata structure for flags
517- examples :
518- - team : ecommerce
519- businessPurpose : experiment
520- owner : " product-team"
521- - team : engineering
522- businessPurpose : gradual-rollout
523- environment : production
488+ example :
489+ team : ecommerce
490+ businessPurpose : experiment
491+ owner : " product-team"
524492 flagMetadataDescription :
525493 description : |
526494 Arbitrary metadata for the flag, useful for telemetry and documentary purposes.
0 commit comments