Skip to content

Commit e024a05

Browse files
tolgaozentolgaozen
authored
Merge pull request #2116 from Permify/update-api-versions-and-config
docs: update API versions in Swagger files and correct field names in…
2 parents e26b4ba + 583385c commit e024a05

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

‎docs/api-reference/apidocs.swagger.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"info": {
44
"title": "Permify API",
55
"description": "Permify is an open source authorization service for creating fine-grained and scalable authorization systems.",
6-
"version": "v1.3.4",
6+
"version": "v1.3.5",
77
"contact": {
88
"name": "API Support",
99
"url": "https://github.com/Permify/permify/issues",

‎docs/api-reference/openapiv2/apidocs.swagger.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"info": {
44
"title": "Permify API",
55
"description": "Permify is an open source authorization service for creating fine-grained and scalable authorization systems.",
6-
"version": "v1.3.4",
6+
"version": "v1.3.5",
77
"contact": {
88
"name": "API Support",
99
"url": "https://github.com/Permify/permify/issues",

‎internal/config/config.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ type (
9393
Exporter string `mapstructure:"exporter"` // Exporter for log data
9494
Endpoint string `mapstructure:"endpoint"` // Endpoint for the log exporter
9595
Insecure bool `mapstructure:"insecure"` // Connect to the collector using the HTTP scheme, instead of HTTPS.
96-
URLPath string `mapstructure:"path"` // Path for the log exporter, if not defined /v1/logs will be used
96+
Urlpath string `mapstructure:"urlpath"` // Path for the log exporter, if not defined /v1/logs will be used
9797
Headers []string `mapstructure:"headers"`
9898
Protocol string `mapstructure:"protocol"` // Protocol for the log exporter, e.g., http, grpc
9999
}
@@ -104,7 +104,7 @@ type (
104104
Exporter string `mapstructure:"exporter"` // Exporter for tracing data
105105
Endpoint string `mapstructure:"endpoint"` // Endpoint for the tracing exporter
106106
Insecure bool `mapstructure:"insecure"` // Connect to the collector using the HTTP scheme, instead of HTTPS.
107-
URLPath string `mapstructure:"path"` // Path for the tracing exporter, if not defined /v1/trace will be used
107+
Urlpath string `mapstructure:"urlpath"` // Path for the tracing exporter, if not defined /v1/trace will be used
108108
Headers []string `mapstructure:"headers"`
109109
Protocol string `mapstructure:"protocol"` // Protocol for the tracing exporter, e.g., http, grpc
110110
}
@@ -115,7 +115,7 @@ type (
115115
Exporter string `mapstructure:"exporter"` // Exporter for metrics data
116116
Endpoint string `mapstructure:"endpoint"` // Endpoint for the metrics exporter
117117
Insecure bool `mapstructure:"insecure"` // Connect to the collector using the HTTP scheme, instead of HTTPS.
118-
URLPath string `mapstructure:"path"` // Path for the metrics exporter, if not defined /v1/metrics will be used
118+
Urlpath string `mapstructure:"urlpath"` // Path for the metrics exporter, if not defined /v1/metrics will be used
119119
Headers []string `mapstructure:"headers"`
120120
Interval int `mapstructure:"interval"`
121121
Protocol string `mapstructure:"protocol"` // Protocol for the metrics exporter, e.g., http, grpc

‎internal/info.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ var Identifier = ""
2323
*/
2424
const (
2525
// Version is the last release of the Permify (e.g. v0.1.0)
26-
Version = "v1.3.4"
26+
Version = "v1.3.5"
2727
)
2828

2929
// Function to create a single line of the ASCII art with centered content and color

‎pkg/cmd/config.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ func NewConfigCommand() *cobra.Command {
4747
f.String("log-exporter", conf.Log.Exporter, "can be; otlp. (integrated metric tools)")
4848
f.String("log-endpoint", conf.Log.Endpoint, "export uri for logs")
4949
f.Bool("log-insecure", conf.Log.Insecure, "use https or http for logs")
50-
f.String("log-urlpath", conf.Log.URLPath, "allow to set url path for otlp exporter")
50+
f.String("log-urlpath", conf.Log.Urlpath, "allow to set url path for otlp exporter")
5151
f.StringSlice("log-headers", conf.Log.Headers, "allows setting custom headers for the log exporter in key-value pairs")
5252
f.String("log-protocol", conf.Log.Protocol, "allows setting the communication protocol for the log exporter, with options http or grpc")
5353
f.Bool("authn-enabled", conf.Authn.Enabled, "enable server authentication")
@@ -64,14 +64,14 @@ func NewConfigCommand() *cobra.Command {
6464
f.String("tracer-exporter", conf.Tracer.Exporter, "can be; jaeger, signoz, zipkin or otlp. (integrated tracing tools)")
6565
f.String("tracer-endpoint", conf.Tracer.Endpoint, "export uri for tracing data")
6666
f.Bool("tracer-insecure", conf.Tracer.Insecure, "use https or http for tracer data, only used for otlp exporter or signoz")
67-
f.String("tracer-urlpath", conf.Tracer.URLPath, "allow to set url path for otlp exporter")
67+
f.String("tracer-urlpath", conf.Tracer.Urlpath, "allow to set url path for otlp exporter")
6868
f.StringSlice("tracer-headers", conf.Tracer.Headers, "allows setting custom headers for the tracer exporter in key-value pairs")
6969
f.String("tracer-protocol", conf.Tracer.Protocol, "allows setting the communication protocol for the tracer exporter, with options http or grpc")
7070
f.Bool("meter-enabled", conf.Meter.Enabled, "switch option for metric")
7171
f.String("meter-exporter", conf.Meter.Exporter, "can be; otlp. (integrated metric tools)")
7272
f.String("meter-endpoint", conf.Meter.Endpoint, "export uri for metric data")
7373
f.Bool("meter-insecure", conf.Meter.Insecure, "use https or http for metric data")
74-
f.String("meter-urlpath", conf.Meter.URLPath, "allow to set url path for otlp exporter")
74+
f.String("meter-urlpath", conf.Meter.Urlpath, "allow to set url path for otlp exporter")
7575
f.StringSlice("meter-headers", conf.Meter.Headers, "allows setting custom headers for the metric exporter in key-value pairs")
7676
f.Int("meter-interval", conf.Meter.Interval, "allows to set metrics to be pushed in certain time interval")
7777
f.String("meter-protocol", conf.Meter.Protocol, "allows setting the communication protocol for the meter exporter, with options http or grpc")
@@ -166,7 +166,7 @@ func conf() func(cmd *cobra.Command, args []string) error {
166166
[]string{"logger.exporter", cfg.Log.Exporter, getKeyOrigin(cmd, "log-exporter", "PERMIFY_LOG_EXPORTER")},
167167
[]string{"logger.endpoint", HideSecret(cfg.Log.Exporter), getKeyOrigin(cmd, "log-endpoint", "PERMIFY_LOG_ENDPOINT")},
168168
[]string{"logger.insecure", fmt.Sprintf("%v", cfg.Log.Insecure), getKeyOrigin(cmd, "log-insecure", "PERMIFY_LOG_INSECURE")},
169-
[]string{"logger.urlpath", cfg.Log.URLPath, getKeyOrigin(cmd, "log-urlpath", "PERMIFY_LOG_URL_PATH")},
169+
[]string{"logger.urlpath", cfg.Log.Urlpath, getKeyOrigin(cmd, "log-urlpath", "PERMIFY_LOG_URL_PATH")},
170170
[]string{"logger.headers", fmt.Sprintf("%v", cfg.Log.Headers), getKeyOrigin(cmd, "log-headers", "PERMIFY_LOG_HEADERS")},
171171
[]string{"logger.protocol", cfg.Log.Protocol, getKeyOrigin(cmd, "log-protocol", "PERMIFY_LOG_PROTOCOL")},
172172
// AUTHN
@@ -185,15 +185,15 @@ func conf() func(cmd *cobra.Command, args []string) error {
185185
[]string{"tracer.exporter", cfg.Tracer.Exporter, getKeyOrigin(cmd, "tracer-exporter", "PERMIFY_TRACER_EXPORTER")},
186186
[]string{"tracer.endpoint", HideSecret(cfg.Tracer.Exporter), getKeyOrigin(cmd, "tracer-endpoint", "PERMIFY_TRACER_ENDPOINT")},
187187
[]string{"tracer.insecure", fmt.Sprintf("%v", cfg.Tracer.Insecure), getKeyOrigin(cmd, "tracer-insecure", "PERMIFY_TRACER_INSECURE")},
188-
[]string{"tracer.urlpath", cfg.Tracer.URLPath, getKeyOrigin(cmd, "tracer-urlpath", "PERMIFY_TRACER_URL_PATH")},
188+
[]string{"tracer.urlpath", cfg.Tracer.Urlpath, getKeyOrigin(cmd, "tracer-urlpath", "PERMIFY_TRACER_URL_PATH")},
189189
[]string{"tracer.headers", fmt.Sprintf("%v", cfg.Tracer.Headers), getKeyOrigin(cmd, "tracer-headers", "PERMIFY_TRACER_HEADERS")},
190190
[]string{"tracer.protocol", cfg.Tracer.Protocol, getKeyOrigin(cmd, "tracer-protocol", "PERMIFY_TRACER_PROTOCOL")},
191191
// METER
192192
[]string{"meter.enabled", fmt.Sprintf("%v", cfg.Meter.Enabled), getKeyOrigin(cmd, "meter-enabled", "PERMIFY_METER_ENABLED")},
193193
[]string{"meter.exporter", cfg.Meter.Exporter, getKeyOrigin(cmd, "meter-exporter", "PERMIFY_METER_EXPORTER")},
194194
[]string{"meter.endpoint", HideSecret(cfg.Meter.Exporter), getKeyOrigin(cmd, "meter-endpoint", "PERMIFY_METER_ENDPOINT")},
195195
[]string{"meter.insecure", fmt.Sprintf("%v", cfg.Meter.Insecure), getKeyOrigin(cmd, "meter-insecure", "PERMIFY_METER_INSECURE")},
196-
[]string{"meter.urlpath", cfg.Meter.URLPath, getKeyOrigin(cmd, "meter-urlpath", "PERMIFY_METER_URL_PATH")},
196+
[]string{"meter.urlpath", cfg.Meter.Urlpath, getKeyOrigin(cmd, "meter-urlpath", "PERMIFY_METER_URL_PATH")},
197197
[]string{"meter.headers", fmt.Sprintf("%v", cfg.Meter.Headers), getKeyOrigin(cmd, "meter-headers", "PERMIFY_METER_HEADERS")},
198198
[]string{"meter.protocol", cfg.Meter.Protocol, getKeyOrigin(cmd, "meter-protocol", "PERMIFY_METER_PROTOCOL")},
199199
[]string{"meter.interval", fmt.Sprintf("%v", cfg.Meter.Interval), getKeyOrigin(cmd, "meter-interval", "PERMIFY_METER_INTERVAL")},

‎pkg/cmd/serve.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ func NewServeCommand() *cobra.Command {
7979
f.String("log-exporter", conf.Log.Exporter, "can be; otlp. (integrated metric tools)")
8080
f.String("log-endpoint", conf.Log.Endpoint, "export uri for logs")
8181
f.Bool("log-insecure", conf.Log.Insecure, "use https or http for logs")
82-
f.String("log-urlpath", conf.Log.URLPath, "allow to set url path for otlp exporter")
82+
f.String("log-urlpath", conf.Log.Urlpath, "allow to set url path for otlp exporter")
8383
f.StringSlice("log-headers", conf.Log.Headers, "allows setting custom headers for the log exporter in key-value pairs")
8484
f.String("log-protocol", conf.Log.Protocol, "allows setting the communication protocol for the log exporter, with options http or grpc")
8585
f.Bool("authn-enabled", conf.Authn.Enabled, "enable server authentication")
@@ -96,14 +96,14 @@ func NewServeCommand() *cobra.Command {
9696
f.String("tracer-exporter", conf.Tracer.Exporter, "can be; jaeger, signoz, zipkin or otlp. (integrated tracing tools)")
9797
f.String("tracer-endpoint", conf.Tracer.Endpoint, "export uri for tracing data")
9898
f.Bool("tracer-insecure", conf.Tracer.Insecure, "use https or http for tracer data, only used for otlp exporter or signoz")
99-
f.String("tracer-urlpath", conf.Tracer.URLPath, "allow to set url path for otlp exporter")
99+
f.String("tracer-urlpath", conf.Tracer.Urlpath, "allow to set url path for otlp exporter")
100100
f.StringSlice("tracer-headers", conf.Tracer.Headers, "allows setting custom headers for the tracer exporter in key-value pairs")
101101
f.String("tracer-protocol", conf.Tracer.Protocol, "allows setting the communication protocol for the tracer exporter, with options http or grpc")
102102
f.Bool("meter-enabled", conf.Meter.Enabled, "switch option for metric")
103103
f.String("meter-exporter", conf.Meter.Exporter, "can be; otlp. (integrated metric tools)")
104104
f.String("meter-endpoint", conf.Meter.Endpoint, "export uri for metric data")
105105
f.Bool("meter-insecure", conf.Meter.Insecure, "use https or http for metric data")
106-
f.String("meter-urlpath", conf.Meter.URLPath, "allow to set url path for otlp exporter")
106+
f.String("meter-urlpath", conf.Meter.Urlpath, "allow to set url path for otlp exporter")
107107
f.StringSlice("meter-headers", conf.Meter.Headers, "allows setting custom headers for the metric exporter in key-value pairs")
108108
f.Int("meter-interval", conf.Meter.Interval, "allows to set metrics to be pushed in certain time interval")
109109
f.String("meter-protocol", conf.Meter.Protocol, "allows setting the communication protocol for the meter exporter, with options http or grpc")
@@ -221,7 +221,7 @@ func serve() func(cmd *cobra.Command, args []string) error {
221221
cfg.Log.Exporter,
222222
cfg.Log.Endpoint,
223223
cfg.Log.Insecure,
224-
cfg.Log.URLPath,
224+
cfg.Log.Urlpath,
225225
headers,
226226
cfg.Log.Protocol,
227227
getLogLevel(cfg.Log.Level),
@@ -297,7 +297,7 @@ func serve() func(cmd *cobra.Command, args []string) error {
297297
cfg.Tracer.Exporter,
298298
cfg.Tracer.Endpoint,
299299
cfg.Tracer.Insecure,
300-
cfg.Tracer.URLPath,
300+
cfg.Tracer.Urlpath,
301301
headers,
302302
cfg.Tracer.Protocol,
303303
)
@@ -349,7 +349,7 @@ func serve() func(cmd *cobra.Command, args []string) error {
349349
cfg.Meter.Exporter,
350350
cfg.Meter.Endpoint,
351351
cfg.Meter.Insecure,
352-
cfg.Meter.URLPath,
352+
cfg.Meter.Urlpath,
353353
headers,
354354
cfg.Meter.Protocol,
355355
)

‎pkg/pb/base/v1/openapi.pb.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎proto/base/v1/openapi.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
99
info: {
1010
title: "Permify API";
1111
description: "Permify is an open source authorization service for creating fine-grained and scalable authorization systems.";
12-
version: "v1.3.4";
12+
version: "v1.3.5";
1313
contact: {
1414
name: "API Support";
1515
url: "https://github.com/Permify/permify/issues";

0 commit comments

Comments
 (0)