Skip to content
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions service/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
example:
key: my-flag
errorCode: INVALID_CONTEXT
errorDetails: "Context is missing required targetingKey property"
errorDetails: "Context property 'plan' must be a string"
Comment thread
jonathannorris marked this conversation as resolved.
"404":
description: Flag not found. The specified flag key does not exist in the flag management system.
content:
Expand Down Expand Up @@ -207,7 +207,7 @@
$ref: "#/components/schemas/bulkEvaluationFailure"
example:
errorCode: INVALID_CONTEXT
errorDetails: "Context is missing required targetingKey property"
errorDetails: "Context property 'plan' must be a string"
"401":
description: Unauthorized. Authentication credentials are missing, invalid, or expired.
"403":
Expand Down Expand Up @@ -344,7 +344,7 @@
errorDetails:
type: string
description: Optional error details description for logging or debugging purposes
example: "Context is missing required targetingKey property"
example: "Context property 'plan' must be a string"
required:
- errorCode
evaluationRequest:
Expand Down Expand Up @@ -439,7 +439,7 @@
description: |
The path + query portion of the endpoint URL. Must start with `/`.
example: "/event-stream?channels=env_abc123_v1"
sseEvent:

Check warning on line 442 in service/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

oas3-unused-component

Potentially unused component has been detected.
description: |
Schema for a single Server-Sent Event in the flag configuration change
notification stream. The `data` field contains a JSON-encoded payload
Expand Down Expand Up @@ -607,11 +607,10 @@
context:
type: object
description: |
Evaluation context containing information used to evaluate feature flags. The context
includes a `targetingKey` (required) along with additional properties such as
user attributes, session data, or request metadata that can be used for targeting rules.
required:
- targetingKey
Evaluation context containing information used to evaluate feature flags. The context
may include an optional `targetingKey` identifying the subject of the evaluation, along
with additional properties such as user attributes, session data, or request metadata
that can be used for targeting rules.
properties:
targetingKey:
type: string
Expand Down
Loading