You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove references to old protos, update `/schemas` submodule.
The old protos were still being used to generate the doc. I've updated
them. Also, the `schemas` submodule was set to some very old version, I
couldn't even run the live docs for that reason. I've updated it to the
latest release of that module.
---------
Signed-off-by: Todd Baert <[email protected]>
&&echo'<!-- WARNING: THIS DOC IS AUTO-GENERATED. DO NOT EDIT! -->'>${PWD}/$(DOCS_DIR)/reference/specifications/protos.md \
122
122
&& sed '/^## Table of Contents/,/#top/d'${PWD}/$(DOCS_DIR)/reference/specifications/protos-with-toc.md >>${PWD}/$(DOCS_DIR)/reference/specifications/protos.md \
Copy file name to clipboardExpand all lines: docs/concepts/syncs.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ See [sync source](../reference/sync-configuration.md#source-configuration) confi
39
39
### gRPC sync
40
40
41
41
The gRPC sync provider streams flag definitions from a gRPC sync provider implementation.
42
-
This stream connection is defined by the [sync service protobuf definition](https://github.com/open-feature/schemas/blob/main/protobuf/sync/v1/sync_service.proto).
42
+
This stream connection is defined by the [sync service protobuf definition](https://github.com/open-feature/flagd-schemas/blob/main/protobuf/flagd/sync/v1/sync.proto).
Copy file name to clipboardExpand all lines: docs/reference/specifications/protos.md
+66-57Lines changed: 66 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,15 @@
3
3
<aname="top"></a>
4
4
5
5
6
-
## schema/v1/schema.proto
6
+
## flagd/evaluation/v1/evaluation.proto
7
7
Flag evaluation API
8
8
9
9
This proto forms the basis of a flag-evaluation API.
10
10
It supports single and bulk evaluation RPCs, and flags of various types, as well as establishing a stream for getting notifications about changes in a flag definition.
11
11
It supports the inclusion of a "context" with each evaluation, which may contain arbitrary attributes relevant to flag evaluation.
This proto defines a simple API to synchronize a feature flag definition.
310
310
It supports establishing a stream for getting notifications about changes in a flag definition.
311
311
312
312
313
-
<aname="sync-v1-FetchAllFlagsRequest"></a>
313
+
<aname="flagd-sync-v1-FetchAllFlagsRequest"></a>
314
314
315
315
### FetchAllFlagsRequest
316
-
FetchAllFlagsRequest is the request to fetch all flags. Flagd sends this request as the client in order to resync its internal state
316
+
FetchAllFlagsRequest is the request to fetch all flags. Clients send this request as the client in order to resync their internal state
317
317
318
318
319
319
| Field | Type | Label | Description |
320
320
| ----- | ---- | ----- | ----------- |
321
-
| provider_id |[string](#string)|| Optional: A unique identifier for flagd(grpc client) initiating the request. The server implementations may utilize this identifier to uniquely identify, validate(ex:- enforce authentication/authorization) and filter flag configurations that it can expose to this request. This field is intended to be optional. However server implementations may enforce it. ex:- provider_id: flagd-weatherapp-sidecar |
321
+
| provider_id |[string](#string)|| Optional: A unique identifier for clients initiating the request. The server implementations may utilize this identifier to uniquely identify, validate(ex:- enforce authentication/authorization) and filter flag configurations that it can expose to this request. This field is intended to be optional. However server implementations may enforce it. ex:- provider_id: flagd-weatherapp-sidecar |
322
322
| selector |[string](#string)|| Optional: A selector for the flag configuration request. The server implementation may utilize this to select flag configurations from a collection, select the source of the flag or combine this to any desired underlying filtering mechanism. ex:- selector: 'source=database,app=weatherapp'|
323
323
324
324
325
325
326
326
327
327
328
328
329
-
<aname="sync-v1-FetchAllFlagsResponse"></a>
329
+
<aname="flagd-sync-v1-FetchAllFlagsResponse"></a>
330
330
331
331
### FetchAllFlagsResponse
332
332
FetchAllFlagsResponse is the server response containing feature flag configurations
@@ -341,10 +341,36 @@ FetchAllFlagsResponse is the server response containing feature flag configurati
341
341
342
342
343
343
344
-
<aname="sync-v1-SyncFlagsRequest"></a>
344
+
<aname="flagd-sync-v1-GetMetadataRequest"></a>
345
+
346
+
### GetMetadataRequest
347
+
GetMetadataRequest is the request for retrieving metadata from the sync service
348
+
349
+
350
+
351
+
352
+
353
+
354
+
<aname="flagd-sync-v1-GetMetadataResponse"></a>
355
+
356
+
### GetMetadataResponse
357
+
GetMetadataResponse contains metadata from the sync service
SyncFlagsRequest is the request initiating the sever-streaming rpc. Flagd sends this request, acting as the client
372
+
SyncFlagsRequest is the request initiating the server-streaming rpc.
373
+
Implementations of Flagd providers and Flagd itself send this request, acting as the client.
348
374
349
375
350
376
| Field | Type | Label | Description |
@@ -357,7 +383,7 @@ SyncFlagsRequest is the request initiating the sever-streaming rpc. Flagd sends
357
383
358
384
359
385
360
-
<aname="sync-v1-SyncFlagsResponse"></a>
386
+
<aname="flagd-sync-v1-SyncFlagsResponse"></a>
361
387
362
388
### SyncFlagsResponse
363
389
SyncFlagsResponse is the server response containing feature flag configurations and the state
@@ -366,45 +392,28 @@ SyncFlagsResponse is the server response containing feature flag configurations
366
392
| Field | Type | Label | Description |
367
393
| ----- | ---- | ----- | ----------- |
368
394
| flag_configuration |[string](#string)|| flagd feature flag configuration. Must be validated to schema - https://raw.githubusercontent.com/open-feature/schemas/main/json/flagd-definitions.json|
369
-
| state |[SyncState](#sync-v1-SyncState)|| State conveying the operation to be performed by flagd. See the descriptions of SyncState for an explanation of supported values |
370
395
371
396
372
397
373
398
374
399
375
400
376
401
377
-
378
-
<aname="sync-v1-SyncState"></a>
379
-
380
-
### SyncState
381
-
SyncState conveys the state of the payload. These states are related to flagd isync.go type definitions but
382
-
contains extras to optimize grpc use case. Refer - https://github.com/open-feature/flagd/blob/main/pkg/sync/isync.go
383
-
384
-
| Name | Number | Description |
385
-
| ---- | ------ | ----------- |
386
-
| SYNC_STATE_UNSPECIFIED | 0 | Value is ignored by the listening flagd |
387
-
| SYNC_STATE_ALL | 1 | All the flags matching the request. This is the default response and other states can be ignored by the implementation. Flagd internally replaces all existing flags for this response state. |
388
-
| SYNC_STATE_ADD | 2 | Convey an addition of a flag. Flagd internally handles this by combining new flags with existing ones |
389
-
| SYNC_STATE_UPDATE | 3 | Convey an update of a flag. Flagd internally attempts to update if the updated flag already exist OR if it does not, it will get added |
390
-
| SYNC_STATE_DELETE | 4 | Convey a deletion of a flag. Flagd internally removes the flag |
391
-
| SYNC_STATE_PING | 5 | Optional server ping to check client connectivity. Handling is ignored by flagd and is to merely support live check |
392
-
393
-
394
402
395
403
396
404
397
405
398
406
399
-
<aname="sync-v1-FlagSyncService"></a>
407
+
<aname="flagd-sync-v1-FlagSyncService"></a>
400
408
401
409
### FlagSyncService
402
410
FlagService implements a server streaming to provide realtime flag configurations
403
411
404
412
| Method Name | Request Type | Response Type | Description |
0 commit comments