groups: Corrects group scope documentation (#710)

Closes #702
ory · Dec 14, 2017 · a58624c · a58624c
1 parent be54a75
commit a58624c
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 19 deletions.
diff --git a/doc.go b/doc.go
@@ -47,8 +47,8 @@
 //         scopes:
 //           hydra.clients: "A scope required to manage OAuth 2.0 Clients"
 //           hydra.policies: "A scope required to manage access control policies"
-//           hydra.groups: "A scope required to manage warden groups"
 //           hydra.warden: "A scope required to make access control inquiries"
+//           hydra.warden.groups: "A scope required to manage warden groups"
 //           hydra.keys.get: "A scope required to fetch JSON Web Keys"
 //           hydra.keys.create: "A scope required to create JSON Web Keys"
 //           hydra.keys.delete: "A scope required to delete JSON Web Keys"

diff --git a/docs/api.swagger.json b/docs/api.swagger.json
@@ -1527,7 +1527,7 @@
         "security": [
           {
             "oauth2": [
-              "hydra.groups"
+              "hydra.warden.groups"
             ]
           }
         ],
@@ -1576,7 +1576,7 @@
         "security": [
           {
             "oauth2": [
-              "hydra.groups"
+              "hydra.warden.groups"
             ]
           }
         ],
@@ -1626,7 +1626,7 @@
         "security": [
           {
             "oauth2": [
-              "hydra.groups"
+              "hydra.warden.groups"
             ]
           }
         ],
@@ -1675,7 +1675,7 @@
         "security": [
           {
             "oauth2": [
-              "hydra.groups"
+              "hydra.warden.groups"
             ]
           }
         ],
@@ -1726,7 +1726,7 @@
         "security": [
           {
             "oauth2": [
-              "hydra.groups"
+              "hydra.warden.groups"
             ]
           }
         ],
@@ -1782,7 +1782,7 @@
         "security": [
           {
             "oauth2": [
-              "hydra.groups"
+              "hydra.warden.groups"
             ]
           }
         ],
@@ -1963,6 +1963,12 @@
     "Handler": {
       "type": "object",
       "properties": {
+        "Generators": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/KeyGenerator"
+          }
+        },
         "H": {
           "$ref": "#/definitions/Writer"
         },
@@ -1976,7 +1982,7 @@
           "$ref": "#/definitions/Firewall"
         }
       },
-      "x-go-package": "github.com/ory/hydra/warden/group"
+      "x-go-package": "github.com/ory/hydra/jwk"
     },
     "KeyGenerator": {
       "type": "object",
@@ -3355,14 +3361,14 @@
       "scopes": {
         "hydra.clients": "A scope required to manage OAuth 2.0 Clients",
         "hydra.consent": "A scope required to fetch and modify consent requests",
-        "hydra.groups": "A scope required to manage warden groups",
         "hydra.health": "A scope required to get health information",
         "hydra.keys.create": "A scope required to create JSON Web Keys",
         "hydra.keys.delete": "A scope required to delete JSON Web Keys",
         "hydra.keys.get": "A scope required to fetch JSON Web Keys",
         "hydra.keys.update": "A scope required to get JSON Web Keys",
         "hydra.policies": "A scope required to manage access control policies",
         "hydra.warden": "A scope required to make access control inquiries",
+        "hydra.warden.groups": "A scope required to manage warden groups",
         "offline": "A scope required when requesting refresh tokens",
         "openid": "Request an OpenID Connect ID Token"
       }

diff --git a/sdk/go/hydra/swagger/README.md b/sdk/go/hydra/swagger/README.md
@@ -136,14 +136,14 @@ Class | Method | HTTP request | Description
 - **Scopes**: 
  - **hydra.clients**: A scope required to manage OAuth 2.0 Clients
  - **hydra.consent**: A scope required to fetch and modify consent requests
- - **hydra.groups**: A scope required to manage warden groups
  - **hydra.health**: A scope required to get health information
  - **hydra.keys.create**: A scope required to create JSON Web Keys
  - **hydra.keys.delete**: A scope required to delete JSON Web Keys
  - **hydra.keys.get**: A scope required to fetch JSON Web Keys
  - **hydra.keys.update**: A scope required to get JSON Web Keys
  - **hydra.policies**: A scope required to manage access control policies
  - **hydra.warden**: A scope required to make access control inquiries
+ - **hydra.warden.groups**: A scope required to manage warden groups
  - **offline**: A scope required when requesting refresh tokens
  - **openid**: Request an OpenID Connect ID Token
 

diff --git a/sdk/go/hydra/swagger/docs/Handler.md b/sdk/go/hydra/swagger/docs/Handler.md
@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**Generators** | [**map[string]KeyGenerator**](KeyGenerator.md) |  | [optional] [default to null]
 **H** | [**Writer**](Writer.md) |  | [optional] [default to null]
 **Manager** | [**Manager**](Manager.md) |  | [optional] [default to null]
 **ResourcePrefix** | **string** |  | [optional] [default to null]

diff --git a/sdk/go/hydra/swagger/handler.go b/sdk/go/hydra/swagger/handler.go
@@ -11,6 +11,8 @@
 package swagger
 
 type Handler struct {
+	Generators map[string]KeyGenerator `json:"Generators,omitempty"`
+
 	H Writer `json:"H,omitempty"`
 
 	Manager Manager `json:"Manager,omitempty"`

diff --git a/sdk/js/swagger/README.md b/sdk/js/swagger/README.md
@@ -235,14 +235,14 @@ Class | Method | HTTP request | Description
 - **Scopes**: 
   - hydra.clients: A scope required to manage OAuth 2.0 Clients
   - hydra.consent: A scope required to fetch and modify consent requests
-  - hydra.groups: A scope required to manage warden groups
   - hydra.health: A scope required to get health information
   - hydra.keys.create: A scope required to create JSON Web Keys
   - hydra.keys.delete: A scope required to delete JSON Web Keys
   - hydra.keys.get: A scope required to fetch JSON Web Keys
   - hydra.keys.update: A scope required to get JSON Web Keys
   - hydra.policies: A scope required to manage access control policies
   - hydra.warden: A scope required to make access control inquiries
+  - hydra.warden.groups: A scope required to manage warden groups
   - offline: A scope required when requesting refresh tokens
   - openid: Request an OpenID Connect ID Token
 
diff --git a/sdk/js/swagger/docs/Handler.md b/sdk/js/swagger/docs/Handler.md
@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**generators** | [**{String: KeyGenerator}**](KeyGenerator.md) |  | [optional] 
 **H** | [**Writer**](Writer.md) |  | [optional] 
 **manager** | [**Manager**](Manager.md) |  | [optional] 
 **resourcePrefix** | **String** |  | [optional] 

diff --git a/sdk/js/swagger/src/model/Handler.js b/sdk/js/swagger/src/model/Handler.js
@@ -18,14 +18,21 @@
   if (typeof define === 'function' && define.amd) {
     // AMD. Register as an anonymous module.
     define(
-      ['ApiClient', 'model/Firewall', 'model/Manager', 'model/Writer'],
+      [
+        'ApiClient',
+        'model/Firewall',
+        'model/KeyGenerator',
+        'model/Manager',
+        'model/Writer'
+      ],
       factory
     )
   } else if (typeof module === 'object' && module.exports) {
     // CommonJS-like environments that support module.exports, like Node.
     module.exports = factory(
       require('../ApiClient'),
       require('./Firewall'),
+      require('./KeyGenerator'),
       require('./Manager'),
       require('./Writer')
     )
@@ -37,11 +44,12 @@
     root.HydraOAuth2OpenIdConnectServer.Handler = factory(
       root.HydraOAuth2OpenIdConnectServer.ApiClient,
       root.HydraOAuth2OpenIdConnectServer.Firewall,
+      root.HydraOAuth2OpenIdConnectServer.KeyGenerator,
       root.HydraOAuth2OpenIdConnectServer.Manager,
       root.HydraOAuth2OpenIdConnectServer.Writer
     )
   }
-})(this, function(ApiClient, Firewall, Manager, Writer) {
+})(this, function(ApiClient, Firewall, KeyGenerator, Manager, Writer) {
   'use strict'
 
   /**
@@ -70,6 +78,11 @@
     if (data) {
       obj = obj || new exports()
 
+      if (data.hasOwnProperty('Generators')) {
+        obj['Generators'] = ApiClient.convertToType(data['Generators'], {
+          String: KeyGenerator
+        })
+      }
       if (data.hasOwnProperty('H')) {
         obj['H'] = Writer.constructFromObject(data['H'])
       }
@@ -89,6 +102,10 @@
     return obj
   }
 
+  /**
+   * @member {Object.<String, module:model/KeyGenerator>} Generators
+   */
+  exports.prototype['Generators'] = undefined
   /**
    * @member {module:model/Writer} H
    */

diff --git a/warden/group/handler.go b/warden/group/handler.go
@@ -92,7 +92,7 @@ func (h *Handler) SetRoutes(r *httprouter.Router) {
 //     Schemes: http, https
 //
 //     Security:
-//       oauth2: hydra.groups
+//       oauth2: hydra.warden.groups
 //
 //     Responses:
 //       200: findGroupsByMemberResponse
@@ -143,7 +143,7 @@ func (h *Handler) FindGroupNames(w http.ResponseWriter, r *http.Request, _ httpr
 //     Schemes: http, https
 //
 //     Security:
-//       oauth2: hydra.groups
+//       oauth2: hydra.warden.groups
 //
 //     Responses:
 //       201: groupResponse
@@ -198,7 +198,7 @@ func (h *Handler) CreateGroup(w http.ResponseWriter, r *http.Request, _ httprout
 //     Schemes: http, https
 //
 //     Security:
-//       oauth2: hydra.groups
+//       oauth2: hydra.warden.groups
 //
 //     Responses:
 //       201: groupResponse
@@ -249,7 +249,7 @@ func (h *Handler) GetGroup(w http.ResponseWriter, r *http.Request, ps httprouter
 //     Schemes: http, https
 //
 //     Security:
-//       oauth2: hydra.groups
+//       oauth2: hydra.warden.groups
 //
 //     Responses:
 //       204: emptyResponse
@@ -299,7 +299,7 @@ func (h *Handler) DeleteGroup(w http.ResponseWriter, r *http.Request, ps httprou
 //     Schemes: http, https
 //
 //     Security:
-//       oauth2: hydra.groups
+//       oauth2: hydra.warden.groups
 //
 //     Responses:
 //       204: emptyResponse
@@ -355,7 +355,7 @@ func (h *Handler) AddGroupMembers(w http.ResponseWriter, r *http.Request, ps htt
 //     Schemes: http, https
 //
 //     Security:
-//       oauth2: hydra.groups
+//       oauth2: hydra.warden.groups
 //
 //     Responses:
 //       204: emptyResponse