Skip to content

Commit cbd283d

Browse files
fix swagger changes
Signed-off-by: Thomas Poignant <[email protected]>
1 parent 51950f5 commit cbd283d

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

Diff for: cmd/relayproxy/docs/docs.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,7 @@ const docTemplate = `{
627627
"type": "object",
628628
"properties": {
629629
"contextKind": {
630-
"description": "ContextKind is the kind of context which generated an Event. This will only be \"anonymousUser\" for events generated\non behalf of an anonymous user or the reserved word \"user\" for events generated on behalf of a non-anonymous user",
630+
"description": "ContextKind is the kind of context which generated an event. This will only be \"anonymousUser\" for events generated\non behalf of an anonymous user or the reserved word \"user\" for events generated on behalf of a non-anonymous user",
631631
"type": "string",
632632
"example": "user"
633633
},
@@ -660,12 +660,12 @@ const docTemplate = `{
660660
]
661661
},
662662
"source": {
663-
"description": "Source indicates where the Event was generated.\nThis is set to SERVER when the Event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.",
663+
"description": "Source indicates where the event was generated.\nThis is set to SERVER when the event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.",
664664
"type": "string",
665665
"example": "SERVER"
666666
},
667667
"userKey": {
668-
"description": "UserKey The key of the user object used in a feature flag evaluation. Details for the user object used in a feature\nflag evaluation as reported by the \"feature\" Event are transmitted periodically with a separate index Event.",
668+
"description": "UserKey The key of the user object used in a feature flag evaluation. Details for the user object used in a feature\nflag evaluation as reported by the \"feature\" event are transmitted periodically with a separate index event.",
669669
"type": "string",
670670
"example": "94a25909-20d8-40cc-8500-fee99b569345"
671671
},

Diff for: cmd/relayproxy/docs/swagger.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -619,7 +619,7 @@
619619
"type": "object",
620620
"properties": {
621621
"contextKind": {
622-
"description": "ContextKind is the kind of context which generated an Event. This will only be \"anonymousUser\" for events generated\non behalf of an anonymous user or the reserved word \"user\" for events generated on behalf of a non-anonymous user",
622+
"description": "ContextKind is the kind of context which generated an event. This will only be \"anonymousUser\" for events generated\non behalf of an anonymous user or the reserved word \"user\" for events generated on behalf of a non-anonymous user",
623623
"type": "string",
624624
"example": "user"
625625
},
@@ -652,12 +652,12 @@
652652
]
653653
},
654654
"source": {
655-
"description": "Source indicates where the Event was generated.\nThis is set to SERVER when the Event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.",
655+
"description": "Source indicates where the event was generated.\nThis is set to SERVER when the event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.",
656656
"type": "string",
657657
"example": "SERVER"
658658
},
659659
"userKey": {
660-
"description": "UserKey The key of the user object used in a feature flag evaluation. Details for the user object used in a feature\nflag evaluation as reported by the \"feature\" Event are transmitted periodically with a separate index Event.",
660+
"description": "UserKey The key of the user object used in a feature flag evaluation. Details for the user object used in a feature\nflag evaluation as reported by the \"feature\" event are transmitted periodically with a separate index event.",
661661
"type": "string",
662662
"example": "94a25909-20d8-40cc-8500-fee99b569345"
663663
},

Diff for: cmd/relayproxy/docs/swagger.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ definitions:
1818
properties:
1919
contextKind:
2020
description: |-
21-
ContextKind is the kind of context which generated an Event. This will only be "anonymousUser" for events generated
21+
ContextKind is the kind of context which generated an event. This will only be "anonymousUser" for events generated
2222
on behalf of an anonymous user or the reserved word "user" for events generated on behalf of a non-anonymous user
2323
example: user
2424
type: string
@@ -50,14 +50,14 @@ definitions:
5050
context about the events generated.
5151
source:
5252
description: |-
53-
Source indicates where the Event was generated.
54-
This is set to SERVER when the Event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.
53+
Source indicates where the event was generated.
54+
This is set to SERVER when the event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.
5555
example: SERVER
5656
type: string
5757
userKey:
5858
description: |-
5959
UserKey The key of the user object used in a feature flag evaluation. Details for the user object used in a feature
60-
flag evaluation as reported by the "feature" Event are transmitted periodically with a separate index Event.
60+
flag evaluation as reported by the "feature" event are transmitted periodically with a separate index event.
6161
example: 94a25909-20d8-40cc-8500-fee99b569345
6262
type: string
6363
value:

Diff for: exporter/feature_event.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,12 @@ type FeatureEvent struct {
4545
// A feature Event will only be generated if the trackEvents attribute of the flag is set to true.
4646
Kind string `json:"kind" example:"feature" parquet:"name=kind, type=BYTE_ARRAY, convertedtype=UTF8"`
4747

48-
// ContextKind is the kind of context which generated an Event. This will only be "anonymousUser" for events generated
48+
// ContextKind is the kind of context which generated an event. This will only be "anonymousUser" for events generated
4949
// on behalf of an anonymous user or the reserved word "user" for events generated on behalf of a non-anonymous user
5050
ContextKind string `json:"contextKind,omitempty" example:"user" parquet:"name=contextKind, type=BYTE_ARRAY, convertedtype=UTF8"`
5151

5252
// UserKey The key of the user object used in a feature flag evaluation. Details for the user object used in a feature
53-
// flag evaluation as reported by the "feature" Event are transmitted periodically with a separate index Event.
53+
// flag evaluation as reported by the "feature" event are transmitted periodically with a separate index event.
5454
UserKey string `json:"userKey" example:"94a25909-20d8-40cc-8500-fee99b569345" parquet:"name=userKey, type=BYTE_ARRAY, convertedtype=UTF8"`
5555

5656
// CreationDate When the feature flag was requested at Unix epoch time in milliseconds.
@@ -75,8 +75,8 @@ type FeatureEvent struct {
7575
// the default version will be 0.
7676
Version string `json:"version" example:"v1.0.0" parquet:"name=version, type=BYTE_ARRAY, convertedtype=UTF8"`
7777

78-
// Source indicates where the Event was generated.
79-
// This is set to SERVER when the Event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.
78+
// Source indicates where the event was generated.
79+
// This is set to SERVER when the event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.
8080
Source string `json:"source" example:"SERVER" parquet:"name=source, type=BYTE_ARRAY, convertedtype=UTF8"`
8181

8282
// Metadata are static information added in the providers to give context about the events generated.

0 commit comments

Comments
 (0)