|
| 1 | +FeatureSettings: |
| 2 | + type: object |
| 3 | + description: Feature-specific settings captured for a variant. |
| 4 | + additionalProperties: false |
| 5 | + properties: |
| 6 | + name: |
| 7 | + type: string |
| 8 | + description: Name of the feature the settings belong to. |
| 9 | + example: 'reranking' |
| 10 | + settings: |
| 11 | + description: Feature settings payload. The shape depends on the feature. |
| 12 | + required: |
| 13 | + - name |
| 14 | + - settings |
| 15 | + |
| 16 | +VariantSettings: |
| 17 | + type: object |
| 18 | + description: Settings captured for one A/B test variant. |
| 19 | + additionalProperties: false |
| 20 | + properties: |
| 21 | + variantId: |
| 22 | + type: integer |
| 23 | + description: One-based index of the variant within the A/B test. The control is variant 1. |
| 24 | + example: 2 |
| 25 | + applied: |
| 26 | + type: boolean |
| 27 | + description: Whether the variant's settings have been applied to the control index. |
| 28 | + featuresSettings: |
| 29 | + type: array |
| 30 | + description: Feature-specific settings captured for the variant. |
| 31 | + items: |
| 32 | + $ref: '#/FeatureSettings' |
| 33 | + indexSettings: |
| 34 | + type: object |
| 35 | + description: Index settings captured for the variant. |
| 36 | + applyTimestamp: |
| 37 | + type: string |
| 38 | + description: Date and time when the variant's settings were applied to the control index, in RFC 3339 format. |
| 39 | + example: 2023-06-17T00:00:00Z |
| 40 | + revertTimestamp: |
| 41 | + type: string |
| 42 | + description: Date and time when the applied settings were reverted on the control index, in RFC 3339 format. |
| 43 | + example: 2023-06-18T00:00:00Z |
| 44 | + declaredTimestamp: |
| 45 | + type: string |
| 46 | + description: Date and time when the variant's settings were captured, in RFC 3339 format. |
| 47 | + example: 2023-06-16T00:00:00Z |
| 48 | + expiredTimestamp: |
| 49 | + type: string |
| 50 | + description: Date and time when the captured settings expired, in RFC 3339 format. |
| 51 | + example: 2023-07-16T00:00:00Z |
| 52 | + required: |
| 53 | + - variantId |
| 54 | + - applied |
| 55 | + |
| 56 | +ABTestSettingsResponse: |
| 57 | + type: object |
| 58 | + description: Captured settings of an A/B test. |
| 59 | + additionalProperties: false |
| 60 | + properties: |
| 61 | + abtestSettings: |
| 62 | + type: array |
| 63 | + description: Captured settings for each variant of the A/B test. |
| 64 | + items: |
| 65 | + $ref: '#/VariantSettings' |
| 66 | + controlIndexInUse: |
| 67 | + type: boolean |
| 68 | + description: Whether another active A/B test is using the control index. |
| 69 | + required: |
| 70 | + - abtestSettings |
| 71 | + - controlIndexInUse |
| 72 | + |
| 73 | +SaveSettingsRequest: |
| 74 | + type: object |
| 75 | + description: Options for capturing a variant's settings. |
| 76 | + additionalProperties: false |
| 77 | + properties: |
| 78 | + saveFeaturesSettings: |
| 79 | + type: boolean |
| 80 | + description: Whether to also capture the variant's index settings and feature-specific settings. This must be true for A/B tests whose variants use different indices so that the captured variant settings can later be applied. |
| 81 | + default: false |
0 commit comments