fix: correct password and profile swagger annotations

ory · Oct 13, 2020 · 668c184 · 668c184
1 parent a8ae759
commit 668c184
Show file tree

Hide file tree

Showing 10 changed files with 132 additions and 52 deletions.
diff --git a/.schema/api.swagger.json b/.schema/api.swagger.json
@@ -1061,8 +1061,7 @@
             "name": "Payload",
             "in": "body",
             "schema": {
-              "type": "object",
-              "additionalProperties": true
+              "type": "object"
             }
           }
         ],
@@ -1324,6 +1323,21 @@
         ],
         "summary": "Complete Settings Flow with Profile Method",
         "operationId": "completeSelfServiceSettingsFlowWithProfileMethod",
+        "parameters": [
+          {
+            "type": "string",
+            "description": "Flow is flow ID.",
+            "name": "flow",
+            "in": "query"
+          },
+          {
+            "name": "Payload",
+            "in": "body",
+            "schema": {
+              "type": "object"
+            }
+          }
+        ],
         "responses": {
           "200": {
             "description": "settingsFlow",
@@ -1728,30 +1742,6 @@
       "type": "string",
       "title": "CredentialsType  represents several different credential types, like password credentials, passwordless credentials,"
     },
-    "FlowMethodConfig": {
-      "type": "object",
-      "required": [
-        "action",
-        "method",
-        "fields"
-      ],
-      "properties": {
-        "action": {
-          "description": "Action should be used as the form action URL `\u003cform action=\"{{ .Action }}\" method=\"post\"\u003e`.",
-          "type": "string"
-        },
-        "fields": {
-          "$ref": "#/definitions/formFields"
-        },
-        "messages": {
-          "$ref": "#/definitions/Messages"
-        },
-        "method": {
-          "description": "Method is the form method (e.g. POST)",
-          "type": "string"
-        }
-      }
-    },
     "ID": {
       "type": "integer",
       "format": "int64"
@@ -2506,14 +2496,38 @@
       ],
       "properties": {
         "config": {
-          "$ref": "#/definitions/FlowMethodConfig"
+          "$ref": "#/definitions/settingsFlowMethodConfig"
         },
         "method": {
           "description": "Method is the name of this flow method.",
           "type": "string"
         }
       }
     },
+    "settingsFlowMethodConfig": {
+      "type": "object",
+      "required": [
+        "action",
+        "method",
+        "fields"
+      ],
+      "properties": {
+        "action": {
+          "description": "Action should be used as the form action URL `\u003cform action=\"{{ .Action }}\" method=\"post\"\u003e`.",
+          "type": "string"
+        },
+        "fields": {
+          "$ref": "#/definitions/formFields"
+        },
+        "messages": {
+          "$ref": "#/definitions/Messages"
+        },
+        "method": {
+          "description": "Method is the form method (e.g. POST)",
+          "type": "string"
+        }
+      }
+    },
     "settingsViaApiResponse": {
       "description": "The Response for Settings Flows via API",
       "type": "object",

diff --git a/...lient/client/public/complete_self_service_settings_flow_with_profile_method_parameters.go b/...lient/client/public/complete_self_service_settings_flow_with_profile_method_parameters.go
diff --git a/internal/httpclient/models/settings_flow_method.go b/internal/httpclient/models/settings_flow_method.go
diff --git a/...l/httpclient/models/flow_method_config.go → ...ent/models/settings_flow_method_config.go b/...l/httpclient/models/flow_method_config.go → ...ent/models/settings_flow_method_config.go
diff --git a/internal/testhelpers/selfservice_settings.go b/internal/testhelpers/selfservice_settings.go
@@ -98,14 +98,14 @@ func ExpectURL(isAPI bool, api, browser string) string {
 	return browser
 }
 
-func GetSettingsFlowMethodConfig(t *testing.T, rs *models.SettingsFlow, id string) *models.FlowMethodConfig {
+func GetSettingsFlowMethodConfig(t *testing.T, rs *models.SettingsFlow, id string) *models.SettingsFlowMethodConfig {
 	require.NotEmpty(t, rs.Methods[id])
 	require.NotEmpty(t, rs.Methods[id].Config)
 	require.NotEmpty(t, rs.Methods[id].Config.Action)
 	return rs.Methods[id].Config
 }
 
-func GetSettingsFlowMethodConfigDeprecated(t *testing.T, primaryUser *http.Client, ts *httptest.Server, id string) *models.FlowMethodConfig {
+func GetSettingsFlowMethodConfigDeprecated(t *testing.T, primaryUser *http.Client, ts *httptest.Server, id string) *models.SettingsFlowMethodConfig {
 	rs := InitializeSettingsFlowViaBrowser(t, primaryUser, ts)
 
 	require.NotEmpty(t, rs.Payload.Methods[id])
@@ -228,7 +228,7 @@ func AddAndLoginIdentities(t *testing.T, reg *driver.RegistryDefault, public *ht
 func SettingsMakeRequest(
 	t *testing.T,
 	isAPI bool,
-	f *models.FlowMethodConfig,
+	f *models.SettingsFlowMethodConfig,
 	hc *http.Client,
 	values string,
 ) (string, *http.Response) {

diff --git a/selfservice/flow/settings/flow_method.go b/selfservice/flow/settings/flow_method.go
@@ -70,7 +70,7 @@ type FlowMethodConfigurator interface {
 	form.MessageAdder
 }
 
-// swagger:type settingsFlowMethodConfig
+// swagger:model settingsFlowMethodConfig
 type FlowMethodConfig struct {
 	// swagger:ignore
 	FlowMethodConfigurator

diff --git a/selfservice/strategy/password/registration.go b/selfservice/strategy/password/registration.go
@@ -99,7 +99,7 @@ type completeSelfServiceRegistrationFlowWithPasswordMethodParameters struct {
 	Flow string `json:"flow"`
 
 	// in: body
-	Payload map[string]interface{}
+	Payload interface{}
 }
 
 // swagger:route POST /self-service/registration/methods/password public completeSelfServiceRegistrationFlowWithPasswordMethod

diff --git a/selfservice/strategy/password/settings_test.go b/selfservice/strategy/password/settings_test.go
@@ -263,7 +263,7 @@ func TestSettings(t *testing.T) {
 		viper.Set(configuration.ViperKeySelfServiceSettingsAfter+"."+configuration.DefaultBrowserReturnURL, rts.URL+"/return-ts")
 		defer viper.Set(configuration.ViperKeySelfServiceSettingsAfter, nil)
 
-		var run = func(t *testing.T, f *models.FlowMethodConfig, isAPI bool, c *http.Client, id *identity.Identity) {
+		var run = func(t *testing.T, f *models.SettingsFlowMethodConfig, isAPI bool, c *http.Client, id *identity.Identity) {
 			values := testhelpers.SDKFormFieldsToURLValues(f.Fields)
 			values.Set("password", randx.MustString(16, randx.AlphaNum))
 			_, res := testhelpers.SettingsMakeRequest(t, isAPI, f, c, testhelpers.EncodeFormAsJSON(t, isAPI, values))

diff --git a/selfservice/strategy/profile/strategy.go b/selfservice/strategy/profile/strategy.go
@@ -82,6 +82,7 @@ func (s *Strategy) SettingsStrategyID() string {
 }
 
 func (s *Strategy) RegisterSettingsRoutes(public *x.RouterPublic) {
+	s.d.CSRFHandler().ExemptPath(RouteSettings)
 	public.POST(RouteSettings, s.d.SessionHandler().IsAuthenticated(s.handleSubmit, settings.OnUnauthenticated(s.c, s.d)))
 	public.GET(RouteSettings, s.d.SessionHandler().IsAuthenticated(s.handleSubmit, settings.OnUnauthenticated(s.c, s.d)))
 }
@@ -117,6 +118,18 @@ func (s *Strategy) PopulateSettingsMethod(r *http.Request, id *identity.Identity
 	return nil
 }
 
+// nolint:deadcode,unused
+// swagger:parameters completeSelfServiceSettingsFlowWithProfileMethod
+type completeSelfServiceSettingsFlowWithProfileMethodParameters struct {
+	// Flow is flow ID.
+	//
+	// in: query
+	Flow string `json:"flow"`
+
+	// in: body
+	Payload interface{}
+}
+
 // swagger:route POST /self-service/settings/methods/profile public completeSelfServiceSettingsFlowWithProfileMethod
 //
 // Complete Settings Flow with Profile Method