diff --git a/schema/adminschema/README.md b/schema/adminschema/README.md index 48699989..1b5b35cc 100644 --- a/schema/adminschema/README.md +++ b/schema/adminschema/README.md @@ -34,7 +34,7 @@ __Version:__ v1 redirectURIs: [ string ], - secret: string + secret: string // The client secret. Ignored in client create requests. } ``` diff --git a/schema/adminschema/v1-gen.go b/schema/adminschema/v1-gen.go index bd49ddf3..a8209eb7 100644 --- a/schema/adminschema/v1-gen.go +++ b/schema/adminschema/v1-gen.go @@ -134,6 +134,7 @@ type Client struct { // 2005. ) (Simple String Comparison). RedirectURIs []string `json:"redirectURIs,omitempty"` + // Secret: The client secret. Ignored in client create requests. Secret string `json:"secret,omitempty"` } diff --git a/schema/adminschema/v1-json.go b/schema/adminschema/v1-json.go index 5d943e99..ec7e74ab 100644 --- a/schema/adminschema/v1-json.go +++ b/schema/adminschema/v1-json.go @@ -1,5 +1,4 @@ package adminschema - // // This file is automatically generated by schema/generator // @@ -28,70 +27,66 @@ const DiscoveryJSON = `{ "parameters": {}, "auth": {}, "schemas": { - "Admin": { - "id": "Admin", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "email": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "State": { - "id": "State", - "type": "object", - "properties": { - "AdminUserCreated": { - "type": "boolean" - } - } - }, - "Client": { - "id": "Client", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The client ID. Ignored in client create requests." - }, - "secret": { - "type": "string", - "description": "The client secret. Ignored in client create requests." - }, - "secret": { - "type": "string", - "format": "byte" - }, - "isAdmin": { - "type": "boolean" - }, - "redirectURIs": { - "type": "array", - "items": { - "type": "string" - }, - "description": "REQUIRED. Array of Redirection URI values used by the Client. One of these registered Redirection URI values MUST exactly match the redirect_uri parameter value used in each Authorization Request, with the matching performed as described in Section 6.2.1 of [RFC3986] ( Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax,” January 2005. ) (Simple String Comparison)." - }, - "clientName": { - "type": "string", - "description": "OPTIONAL. Name of the Client to be presented to the End-User. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." - }, - "logoURI": { - "type": "string", - "description": "OPTIONAL. URL that references a logo for the Client application. If present, the server SHOULD display this image to the End-User during approval. The value of this field MUST point to a valid image file. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." - }, - "clientURI": { - "type": "string", - "description": "OPTIONAL. URL of the home page of the Client. The value of this field MUST point to a valid Web page. If present, the server SHOULD display this URL to the End-User in a followable fashion. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." - } + "Admin": { + "id": "Admin", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "email": { + "type": "string" + }, + "password": { + "type": "string" } - }, + } + }, + "State": { + "id": "State", + "type": "object", + "properties": { + "AdminUserCreated": { + "type": "boolean" + } + } + }, + "Client": { + "id": "Client", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The client ID. Ignored in client create requests." + }, + "secret": { + "type": "string", + "description": "The client secret. Ignored in client create requests." + }, + "isAdmin": { + "type": "boolean" + }, + "redirectURIs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "REQUIRED. Array of Redirection URI values used by the Client. One of these registered Redirection URI values MUST exactly match the redirect_uri parameter value used in each Authorization Request, with the matching performed as described in Section 6.2.1 of [RFC3986] ( Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax,” January 2005. ) (Simple String Comparison)." + }, + "clientName": { + "type": "string", + "description": "OPTIONAL. Name of the Client to be presented to the End-User. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." + }, + "logoURI": { + "type": "string", + "description": "OPTIONAL. URL that references a logo for the Client application. If present, the server SHOULD display this image to the End-User during approval. The value of this field MUST point to a valid image file. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." + }, + "clientURI": { + "type": "string", + "description": "OPTIONAL. URL of the home page of the Client. The value of this field MUST point to a valid Web page. If present, the server SHOULD display this URL to the End-User in a followable fashion. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." + } + } + }, "ClientCreateRequest": { "id": "ClientCreateRequest", "type": "object", @@ -107,78 +102,77 @@ const DiscoveryJSON = `{ "type": "object", "description": "Upon successful registration, an ID and secret is assigned to the client.", "properties": { - "client":{ + "client": { "$ref": "Client" } } } }, "resources": { - "Admin": { - "methods": { - "Get": { - "id": "dex.admin.Admin.Get", - "description": "Retrieve information about an admin user.", - "httpMethod": "GET", - "path": "admin/{id}", - "parameters": { - "id": { - "type": "string", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Admin" - } - - }, - "Create": { - "id": "dex.admin.Admin.Create", - "description": "Create a new admin user.", - "httpMethod": "POST", - "path": "admin", - "request": { - "$ref": "Admin" - }, - "response": { - "$ref": "Admin" - } - } + "Admin": { + "methods": { + "Get": { + "id": "dex.admin.Admin.Get", + "description": "Retrieve information about an admin user.", + "httpMethod": "GET", + "path": "admin/{id}", + "parameters": { + "id": { + "type": "string", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "id" + ], + "response": { + "$ref": "Admin" } - }, - "State": { - "methods": { - "Get": { - "id": "dex.admin.State.Get", - "description": "Get the state of the Dex DB", - "httpMethod": "GET", - "path": "state", - "response": { - "$ref": "State" - } - } - } - }, - "Client": { - "methods": { - "Create": { - "id": "dex.admin.Client.Create", - "description": "Register an OpenID Connect client.", - "httpMethod": "POST", - "path": "client", - "request": { - "$ref": "ClientCreateRequest" - }, - "response": { - "$ref": "ClientCreateResponse" - } - } + }, + "Create": { + "id": "dex.admin.Admin.Create", + "description": "Create a new admin user.", + "httpMethod": "POST", + "path": "admin", + "request": { + "$ref": "Admin" + }, + "response": { + "$ref": "Admin" } + } } + }, + "State": { + "methods": { + "Get": { + "id": "dex.admin.State.Get", + "description": "Get the state of the Dex DB", + "httpMethod": "GET", + "path": "state", + "response": { + "$ref": "State" + } + } + } + }, + "Client": { + "methods": { + "Create": { + "id": "dex.admin.Client.Create", + "description": "Register an OpenID Connect client.", + "httpMethod": "POST", + "path": "client", + "request": { + "$ref": "ClientCreateRequest" + }, + "response": { + "$ref": "ClientCreateResponse" + } + } + } + } } } -` +` \ No newline at end of file diff --git a/schema/adminschema/v1.json b/schema/adminschema/v1.json index 4aa8573c..ae03da8b 100644 --- a/schema/adminschema/v1.json +++ b/schema/adminschema/v1.json @@ -21,66 +21,66 @@ "parameters": {}, "auth": {}, "schemas": { - "Admin": { - "id": "Admin", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "email": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "State": { - "id": "State", - "type": "object", - "properties": { - "AdminUserCreated": { - "type": "boolean" - } - } - }, - "Client": { - "id": "Client", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The client ID. Ignored in client create requests." - }, - "secret": { - "type": "string", - "description": "The client secret. Ignored in client create requests." - }, - "isAdmin": { - "type": "boolean" - }, - "redirectURIs": { - "type": "array", - "items": { - "type": "string" - }, - "description": "REQUIRED. Array of Redirection URI values used by the Client. One of these registered Redirection URI values MUST exactly match the redirect_uri parameter value used in each Authorization Request, with the matching performed as described in Section 6.2.1 of [RFC3986] ( Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax,” January 2005. ) (Simple String Comparison)." - }, - "clientName": { - "type": "string", - "description": "OPTIONAL. Name of the Client to be presented to the End-User. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." - }, - "logoURI": { - "type": "string", - "description": "OPTIONAL. URL that references a logo for the Client application. If present, the server SHOULD display this image to the End-User during approval. The value of this field MUST point to a valid image file. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." - }, - "clientURI": { - "type": "string", - "description": "OPTIONAL. URL of the home page of the Client. The value of this field MUST point to a valid Web page. If present, the server SHOULD display this URL to the End-User in a followable fashion. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." - } + "Admin": { + "id": "Admin", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "email": { + "type": "string" + }, + "password": { + "type": "string" } - }, + } + }, + "State": { + "id": "State", + "type": "object", + "properties": { + "AdminUserCreated": { + "type": "boolean" + } + } + }, + "Client": { + "id": "Client", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The client ID. Ignored in client create requests." + }, + "secret": { + "type": "string", + "description": "The client secret. Ignored in client create requests." + }, + "isAdmin": { + "type": "boolean" + }, + "redirectURIs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "REQUIRED. Array of Redirection URI values used by the Client. One of these registered Redirection URI values MUST exactly match the redirect_uri parameter value used in each Authorization Request, with the matching performed as described in Section 6.2.1 of [RFC3986] ( Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax,” January 2005. ) (Simple String Comparison)." + }, + "clientName": { + "type": "string", + "description": "OPTIONAL. Name of the Client to be presented to the End-User. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." + }, + "logoURI": { + "type": "string", + "description": "OPTIONAL. URL that references a logo for the Client application. If present, the server SHOULD display this image to the End-User during approval. The value of this field MUST point to a valid image file. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." + }, + "clientURI": { + "type": "string", + "description": "OPTIONAL. URL of the home page of the Client. The value of this field MUST point to a valid Web page. If present, the server SHOULD display this URL to the End-User in a followable fashion. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) ." + } + } + }, "ClientCreateRequest": { "id": "ClientCreateRequest", "type": "object", @@ -96,77 +96,76 @@ "type": "object", "description": "Upon successful registration, an ID and secret is assigned to the client.", "properties": { - "client":{ + "client": { "$ref": "Client" } } } }, "resources": { - "Admin": { - "methods": { - "Get": { - "id": "dex.admin.Admin.Get", - "description": "Retrieve information about an admin user.", - "httpMethod": "GET", - "path": "admin/{id}", - "parameters": { - "id": { - "type": "string", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Admin" - } - - }, - "Create": { - "id": "dex.admin.Admin.Create", - "description": "Create a new admin user.", - "httpMethod": "POST", - "path": "admin", - "request": { - "$ref": "Admin" - }, - "response": { - "$ref": "Admin" - } - } + "Admin": { + "methods": { + "Get": { + "id": "dex.admin.Admin.Get", + "description": "Retrieve information about an admin user.", + "httpMethod": "GET", + "path": "admin/{id}", + "parameters": { + "id": { + "type": "string", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "id" + ], + "response": { + "$ref": "Admin" } - }, - "State": { - "methods": { - "Get": { - "id": "dex.admin.State.Get", - "description": "Get the state of the Dex DB", - "httpMethod": "GET", - "path": "state", - "response": { - "$ref": "State" - } - } - } - }, - "Client": { - "methods": { - "Create": { - "id": "dex.admin.Client.Create", - "description": "Register an OpenID Connect client.", - "httpMethod": "POST", - "path": "client", - "request": { - "$ref": "ClientCreateRequest" - }, - "response": { - "$ref": "ClientCreateResponse" - } - } + }, + "Create": { + "id": "dex.admin.Admin.Create", + "description": "Create a new admin user.", + "httpMethod": "POST", + "path": "admin", + "request": { + "$ref": "Admin" + }, + "response": { + "$ref": "Admin" } + } } + }, + "State": { + "methods": { + "Get": { + "id": "dex.admin.State.Get", + "description": "Get the state of the Dex DB", + "httpMethod": "GET", + "path": "state", + "response": { + "$ref": "State" + } + } + } + }, + "Client": { + "methods": { + "Create": { + "id": "dex.admin.Client.Create", + "description": "Register an OpenID Connect client.", + "httpMethod": "POST", + "path": "client", + "request": { + "$ref": "ClientCreateRequest" + }, + "response": { + "$ref": "ClientCreateResponse" + } + } + } + } } } diff --git a/schema/workerschema/README.md b/schema/workerschema/README.md index 203b3154..0e396d66 100644 --- a/schema/workerschema/README.md +++ b/schema/workerschema/README.md @@ -232,8 +232,8 @@ A client with associated public metadata. > |Name|Located in|Description|Required|Type| |:-----|:-----|:-----|:-----|:-----| -| clientid | path | | Yes | string | | userid | path | | Yes | string | +| clientid | path | | Yes | string | > __Responses__ @@ -310,8 +310,8 @@ A client with associated public metadata. > |Name|Located in|Description|Required|Type| |:-----|:-----|:-----|:-----|:-----| -| nextPageToken | query | | No | string | | maxResults | query | | No | integer | +| nextPageToken | query | | No | string | > __Responses__ diff --git a/schema/workerschema/v1-json.go b/schema/workerschema/v1-json.go index 06a5a6bf..77707848 100644 --- a/schema/workerschema/v1-json.go +++ b/schema/workerschema/v1-json.go @@ -1,5 +1,4 @@ package workerschema - // // This file is automatically generated by schema/generator // @@ -56,26 +55,26 @@ const DiscoveryJSON = `{ } } }, - "RefreshClient": { + "RefreshClient": { "id": "Client", "type": "object", - "description": "A client with associated public metadata.", + "description": "A client with associated public metadata.", "properties": { - "clientID": { - "type": "string" - }, - "clientName": { - "type": "string" - }, - "logoURI": { - "type": "string" - }, - "clientURI": { - "type": "string" - } + "clientID": { + "type": "string" + }, + "clientName": { + "type": "string" + }, + "logoURI": { + "type": "string" + }, + "clientURI": { + "type": "string" + } } - }, - "RefreshClientList": { + }, + "RefreshClientList": { "id": "RefreshClientList", "type": "object", "properties": { @@ -86,7 +85,7 @@ const DiscoveryJSON = `{ } } } - }, + }, "ClientWithSecret": { "id": "Client", "type": "object", @@ -154,7 +153,7 @@ const DiscoveryJSON = `{ "type": "object", "properties": { "user": { - "$ref": "User" + "$ref": "User" } } }, @@ -280,7 +279,8 @@ const DiscoveryJSON = `{ "httpMethod": "DELETE", "path": "account/{userid}/refresh/{clientid}", "parameterOrder": [ - "userid","clientid" + "userid", + "clientid" ], "parameters": { "clientid": { @@ -420,4 +420,4 @@ const DiscoveryJSON = `{ } } } -` +` \ No newline at end of file diff --git a/schema/workerschema/v1.json b/schema/workerschema/v1.json index 80343d1e..76be8e57 100644 --- a/schema/workerschema/v1.json +++ b/schema/workerschema/v1.json @@ -49,26 +49,26 @@ } } }, - "RefreshClient": { + "RefreshClient": { "id": "Client", "type": "object", - "description": "A client with associated public metadata.", + "description": "A client with associated public metadata.", "properties": { - "clientID": { - "type": "string" - }, - "clientName": { - "type": "string" - }, - "logoURI": { - "type": "string" - }, - "clientURI": { - "type": "string" - } + "clientID": { + "type": "string" + }, + "clientName": { + "type": "string" + }, + "logoURI": { + "type": "string" + }, + "clientURI": { + "type": "string" + } } - }, - "RefreshClientList": { + }, + "RefreshClientList": { "id": "RefreshClientList", "type": "object", "properties": { @@ -79,7 +79,7 @@ } } } - }, + }, "ClientWithSecret": { "id": "Client", "type": "object", @@ -147,7 +147,7 @@ "type": "object", "properties": { "user": { - "$ref": "User" + "$ref": "User" } } }, @@ -273,7 +273,8 @@ "httpMethod": "DELETE", "path": "account/{userid}/refresh/{clientid}", "parameterOrder": [ - "userid","clientid" + "userid", + "clientid" ], "parameters": { "clientid": {