fix: mark flow methods' fields as required (#708)

ory · Oct 1, 2020 · 834c607 · 834c607
1 parent ce9cb9f
commit 834c607
Show file tree

Hide file tree

Showing 10 changed files with 100 additions and 21 deletions.
diff --git a/.schema/api.swagger.json b/.schema/api.swagger.json
@@ -2225,6 +2225,10 @@
     },
     "recoveryFlowMethod": {
       "type": "object",
+      "required": [
+        "method",
+        "config"
+      ],
       "properties": {
         "config": {
           "$ref": "#/definitions/recoveryFlowMethodConfig"
@@ -2323,6 +2327,10 @@
     },
     "registrationFlowMethod": {
       "type": "object",
+      "required": [
+        "method",
+        "config"
+      ],
       "properties": {
         "config": {
           "$ref": "#/definitions/registrationFlowMethodConfig"
@@ -2486,6 +2494,10 @@
     },
     "settingsFlowMethod": {
       "type": "object",
+      "required": [
+        "method",
+        "config"
+      ],
       "properties": {
         "config": {
           "$ref": "#/definitions/FlowMethodConfig"
@@ -2562,6 +2574,10 @@
     },
     "verificationFlowMethod": {
       "type": "object",
+      "required": [
+        "method",
+        "config"
+      ],
       "properties": {
         "config": {
           "$ref": "#/definitions/verificationFlowMethodConfig"

diff --git a/internal/httpclient/models/recovery_flow_method.go b/internal/httpclient/models/recovery_flow_method.go
diff --git a/internal/httpclient/models/registration_flow_method.go b/internal/httpclient/models/registration_flow_method.go
diff --git a/internal/httpclient/models/settings_flow_method.go b/internal/httpclient/models/settings_flow_method.go
diff --git a/internal/httpclient/models/verification_flow_method.go b/internal/httpclient/models/verification_flow_method.go
diff --git a/selfservice/flow/recovery/flow_method.go b/selfservice/flow/recovery/flow_method.go
@@ -15,9 +15,13 @@ import (
 // swagger:model recoveryFlowMethod
 type FlowMethod struct {
 	// Method contains the request credentials type.
+	//
+	// required: true
 	Method string `json:"method" db:"method"`
 
 	// Config is the credential type's config.
+	//
+	// required: true
 	Config *FlowMethodConfig `json:"config" db:"config"`
 
 	// ID is a helper struct field for gobuffalo.pop.

diff --git a/selfservice/flow/registration/flow_method.go b/selfservice/flow/registration/flow_method.go
@@ -16,9 +16,13 @@ import (
 // swagger:model registrationFlowMethod
 type FlowMethod struct {
 	// Method contains the flow method's credentials type.
+	//
+	// required: true
 	Method identity.CredentialsType `json:"method" faker:"string" db:"method"`
 
 	// Config is the credential type's config.
+	//
+	// required: true
 	Config *FlowMethodConfig `json:"config" db:"config"`
 
 	// ID is a helper struct field for gobuffalo.pop.

diff --git a/selfservice/flow/settings/flow_method.go b/selfservice/flow/settings/flow_method.go
@@ -15,9 +15,13 @@ import (
 // swagger:model settingsFlowMethod
 type FlowMethod struct {
 	// Method is the name of this flow method.
+	//
+	// required: true
 	Method string `json:"method" db:"method"`
 
 	// Config is the credential type's config.
+	//
+	// required: true
 	Config *FlowMethodConfig `json:"config" db:"config"`
 
 	// ID is a helper struct field for gobuffalo.pop.

diff --git a/selfservice/flow/verification/flow_method.go b/selfservice/flow/verification/flow_method.go
@@ -15,9 +15,13 @@ import (
 // swagger:model verificationFlowMethod
 type FlowMethod struct {
 	// Method contains the request credentials type.
+	//
+	// required: true
 	Method string `json:"method" db:"method"`
 
 	// Config is the credential type's config.
+	//
+	// required: true
 	Config *FlowMethodConfig `json:"config" db:"config"`
 
 	// ID is a helper struct field for gobuffalo.pop.

diff --git a/selfservice/strategy/oidc/strategy_settings_test.go b/selfservice/strategy/oidc/strategy_settings_test.go
@@ -189,7 +189,7 @@ func TestSettingsStrategy(t *testing.T) {
 		assert.EqualValues(t, req.IssuedAt, time.Time(*rs.Payload.IssuedAt))
 
 		require.NotNil(t, identity.CredentialsTypeOIDC.String(), rs.Payload.Methods[identity.CredentialsTypeOIDC.String()])
-		require.EqualValues(t, identity.CredentialsTypeOIDC.String(), rs.Payload.Methods[identity.CredentialsTypeOIDC.String()].Method)
+		require.EqualValues(t, identity.CredentialsTypeOIDC.String(), *rs.Payload.Methods[identity.CredentialsTypeOIDC.String()].Method)
 		require.EqualValues(t, publicTS.URL+oidc.SettingsPath+"?flow="+req.ID.String(),
 			*rs.Payload.Methods[identity.CredentialsTypeOIDC.String()].Config.Action)
 	})