diff --git a/internal/httpclient/models/generic_error.go b/internal/httpclient/models/generic_error.go index a69ff8350f..e7c2a290ce 100644 --- a/internal/httpclient/models/generic_error.go +++ b/internal/httpclient/models/generic_error.go @@ -10,7 +10,7 @@ import ( "github.com/go-openapi/swag" ) -// GenericError The standard error format +// GenericError GenericError The standard error format // // swagger:model genericError type GenericError struct { diff --git a/internal/httpclient/models/health_not_ready_status.go b/internal/httpclient/models/health_not_ready_status.go index 64626783ed..4e697f273c 100644 --- a/internal/httpclient/models/health_not_ready_status.go +++ b/internal/httpclient/models/health_not_ready_status.go @@ -10,7 +10,7 @@ import ( "github.com/go-openapi/swag" ) -// HealthNotReadyStatus health not ready status +// HealthNotReadyStatus HealthNotReadyStatus health not ready status // // swagger:model healthNotReadyStatus type HealthNotReadyStatus struct { diff --git a/internal/httpclient/models/json_web_key.go b/internal/httpclient/models/json_web_key.go index 6425597b3c..1456f19fab 100644 --- a/internal/httpclient/models/json_web_key.go +++ b/internal/httpclient/models/json_web_key.go @@ -10,7 +10,7 @@ import ( "github.com/go-openapi/swag" ) -// JSONWebKey json web key +// JSONWebKey JSONWebKey json web key // // swagger:model jsonWebKey type JSONWebKey struct { diff --git a/internal/httpclient/models/json_web_key_set.go b/internal/httpclient/models/json_web_key_set.go index 66fee7d68d..66eb83fabd 100644 --- a/internal/httpclient/models/json_web_key_set.go +++ b/internal/httpclient/models/json_web_key_set.go @@ -13,7 +13,7 @@ import ( "github.com/go-openapi/swag" ) -// JSONWebKeySet JSONWebKeySet json web key set +// JSONWebKeySet json web key set // // swagger:model jsonWebKeySet type JSONWebKeySet struct { diff --git a/internal/httpclient/models/rule.go b/internal/httpclient/models/rule.go index 275ded0f54..b72a698519 100644 --- a/internal/httpclient/models/rule.go +++ b/internal/httpclient/models/rule.go @@ -13,7 +13,7 @@ import ( "github.com/go-openapi/swag" ) -// Rule swaggerRule is a single rule that will get checked on every HTTP request. +// Rule Rule swaggerRule is a single rule that will get checked on every HTTP request. // // swagger:model rule type Rule struct { diff --git a/internal/httpclient/models/rule_handler.go b/internal/httpclient/models/rule_handler.go index 88cc88ae0a..e3bb224748 100644 --- a/internal/httpclient/models/rule_handler.go +++ b/internal/httpclient/models/rule_handler.go @@ -10,7 +10,7 @@ import ( "github.com/go-openapi/swag" ) -// RuleHandler RuleHandler RuleHandler rule handler +// RuleHandler rule handler // // swagger:model ruleHandler type RuleHandler struct { diff --git a/internal/httpclient/models/rule_match.go b/internal/httpclient/models/rule_match.go index 6902c35969..c165d80849 100644 --- a/internal/httpclient/models/rule_match.go +++ b/internal/httpclient/models/rule_match.go @@ -10,7 +10,7 @@ import ( "github.com/go-openapi/swag" ) -// RuleMatch RuleMatch RuleMatch rule match +// RuleMatch RuleMatch RuleMatch RuleMatch rule match // // swagger:model ruleMatch type RuleMatch struct { diff --git a/internal/httpclient/models/upstream.go b/internal/httpclient/models/upstream.go index 7418df96a4..367aff5e92 100644 --- a/internal/httpclient/models/upstream.go +++ b/internal/httpclient/models/upstream.go @@ -10,7 +10,7 @@ import ( "github.com/go-openapi/swag" ) -// Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream upstream +// Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream upstream // // swagger:model Upstream type Upstream struct { diff --git a/internal/httpclient/models/version.go b/internal/httpclient/models/version.go index 8e687bcb20..5c3daa3785 100644 --- a/internal/httpclient/models/version.go +++ b/internal/httpclient/models/version.go @@ -10,7 +10,7 @@ import ( "github.com/go-openapi/swag" ) -// Version version +// Version Version version // // swagger:model version type Version struct { diff --git a/spec/api.json b/spec/api.json index ec5af1f643..47ec08f3ca 100755 --- a/spec/api.json +++ b/spec/api.json @@ -34,7 +34,7 @@ "type": "string" }, "Upstream": { - "description": "Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream upstream", + "description": "Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream upstream", "properties": { "preserve_host": { "description": "PreserveHost, if false (the default), tells ORY Oathkeeper to set the upstream request's Host header to the\nhostname of the API's upstream's URL. Setting this flag to true instructs ORY Oathkeeper not to do so.", @@ -52,7 +52,7 @@ "type": "object" }, "genericError": { - "description": "The standard error format", + "description": "GenericError The standard error format", "properties": { "code": { "description": "code", @@ -87,6 +87,7 @@ "type": "object" }, "healthNotReadyStatus": { + "description": "HealthNotReadyStatus health not ready status", "properties": { "errors": { "additionalProperties": { @@ -108,6 +109,7 @@ "type": "object" }, "jsonWebKey": { + "description": "JSONWebKey json web key", "properties": { "alg": { "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", @@ -184,7 +186,6 @@ "type": "object" }, "jsonWebKeySet": { - "description": "JSONWebKeySet json web key set", "properties": { "keys": { "description": "The value of the \"keys\" parameter is an array of JWK values. By\ndefault, the order of the JWK values within the array does not imply\nan order of preference among them, although applications of JWK Sets\ncan choose to assign a meaning to the order for their purposes, if\ndesired.", @@ -230,11 +231,10 @@ "$ref": "#/components/schemas/Upstream" } }, - "title": "swaggerRule is a single rule that will get checked on every HTTP request.", + "title": "Rule swaggerRule is a single rule that will get checked on every HTTP request.", "type": "object" }, "ruleHandler": { - "description": "RuleHandler RuleHandler rule handler", "properties": { "config": { "description": "Config contains the configuration for the handler. Please read the user\nguide for a complete list of each handler's available settings.", @@ -248,7 +248,7 @@ "type": "object" }, "ruleMatch": { - "description": "RuleMatch RuleMatch rule match", + "description": "RuleMatch RuleMatch RuleMatch rule match", "properties": { "methods": { "description": "An array of HTTP methods (e.g. GET, POST, PUT, DELETE, ...). When ORY Oathkeeper searches for rules\nto decide what to do with an incoming request to the proxy server, it compares the HTTP method of the incoming\nrequest with the HTTP methods of each rules. If a match is found, the rule is considered a partial match.\nIf the matchesUrl field is satisfied as well, the rule is considered a full match.", @@ -265,6 +265,7 @@ "type": "object" }, "version": { + "description": "Version version", "properties": { "version": { "description": "Version is the service's version.", diff --git a/spec/swagger.json b/spec/swagger.json index 64008c3fe5..393d483a2f 100755 --- a/spec/swagger.json +++ b/spec/swagger.json @@ -218,7 +218,7 @@ "definitions": { "UUID": { "type": "string", "format": "uuid4" }, "Upstream": { - "description": "Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream upstream", + "description": "Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream Upstream upstream", "type": "object", "properties": { "preserve_host": { @@ -236,7 +236,7 @@ } }, "genericError": { - "description": "The standard error format", + "description": "GenericError The standard error format", "type": "object", "properties": { "code": { @@ -271,6 +271,7 @@ } }, "healthNotReadyStatus": { + "description": "HealthNotReadyStatus health not ready status", "type": "object", "properties": { "errors": { @@ -292,6 +293,7 @@ } }, "jsonWebKey": { + "description": "JSONWebKey json web key", "type": "object", "properties": { "alg": { @@ -368,7 +370,6 @@ } }, "jsonWebKeySet": { - "description": "JSONWebKeySet json web key set", "type": "object", "properties": { "keys": { @@ -382,7 +383,7 @@ }, "rule": { "type": "object", - "title": "swaggerRule is a single rule that will get checked on every HTTP request.", + "title": "Rule swaggerRule is a single rule that will get checked on every HTTP request.", "properties": { "authenticators": { "description": "Authenticators is a list of authentication handlers that will try and authenticate the provided credentials.\nAuthenticators are checked iteratively from index 0 to n and if the first authenticator to return a positive\nresult will be the one used.\n\nIf you want the rule to first check a specific authenticator before \"falling back\" to others, have that authenticator\nas the first item in the array.", @@ -418,7 +419,6 @@ } }, "ruleHandler": { - "description": "RuleHandler RuleHandler rule handler", "type": "object", "properties": { "config": { @@ -432,7 +432,7 @@ } }, "ruleMatch": { - "description": "RuleMatch RuleMatch rule match", + "description": "RuleMatch RuleMatch RuleMatch rule match", "type": "object", "properties": { "methods": { @@ -449,6 +449,7 @@ } }, "version": { + "description": "Version version", "type": "object", "properties": { "version": {