maintain: use json tag for property names

BREAKING CHANGE: change LoginResponse polymorphicId to polymorphicID
infrahq · Apr 5, 2022 · 5fa6413 · 5fa6413
1 parent 7cd72d7
commit 5fa6413
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 20 deletions.
diff --git a/api/login.go b/api/login.go
@@ -10,17 +10,17 @@ type LoginRequestOIDC struct {
 
 type LoginRequestPasswordCredentials struct {
 	Email    string `json:"email" validate:"required"`
-	Password string `json:"password"  validate:"required"`
+	Password string `json:"password" validate:"required"`
 }
 
 type LoginRequest struct {
-	OIDC                *LoginRequestOIDC                `json:"oidc" validate:"excluded_with=KeyExchange,excluded_with=PasswordCredentials"`
-	AccessKey           string                           `json:"accessKey"  validate:"excluded_with=OIDC,excluded_with=PasswordCredentials"`
+	AccessKey           string                           `json:"accessKey" validate:"excluded_with=OIDC,excluded_with=PasswordCredentials"`
 	PasswordCredentials *LoginRequestPasswordCredentials `json:"passwordCredentials" validate:"excluded_with=OIDC,excluded_with=AccessKey"`
+	OIDC                *LoginRequestOIDC                `json:"oidc" validate:"excluded_with=KeyExchange,excluded_with=PasswordCredentials"`
 }
 
 type LoginResponse struct {
-	PolymorphicID          uid.PolymorphicID `json:"polymorphicId"`
+	PolymorphicID          uid.PolymorphicID `json:"polymorphicID"`
 	Name                   string            `json:"name"`
 	AccessKey              string            `json:"accessKey"`
 	PasswordUpdateRequired bool              `json:"passwordUpdateRequired,omitempty"`

diff --git a/docs/api/openapi3.json b/docs/api/openapi3.json
@@ -122,11 +122,11 @@
         "properties": {
           "connection": {
             "properties": {
-              "CA": {
+              "ca": {
                 "example": "-----BEGIN CERTIFICATE-----\nMIIDNTCCAh2gAwIBAgIRALRetnpcTo9O3V2fAK3ix+c\n-----END CERTIFICATE-----\n",
                 "type": "string"
               },
-              "URL": {
+              "url": {
                 "example": "aa60eexample.us-west-2.elb.amazonaws.com",
                 "type": "string"
               }
@@ -173,13 +173,13 @@
           "fieldErrors": {
             "items": {
               "properties": {
-                "Errors": {
+                "errors": {
                   "items": {
                     "type": "string"
                   },
                   "type": "array"
                 },
-                "FieldName": {
+                "fieldName": {
                   "type": "string"
                 }
               },
@@ -344,7 +344,7 @@
           "passwordUpdateRequired": {
             "type": "boolean"
           },
-          "polymorphicId": {
+          "polymorphicID": {
             "example": "i:4yJ3n3D8E3",
             "format": "poly-uid",
             "pattern": "\\w:[\\da-zA-HJ-NP-Z]{1,11}",
@@ -805,11 +805,11 @@
                 "properties": {
                   "connection": {
                     "properties": {
-                      "CA": {
+                      "ca": {
                         "example": "-----BEGIN CERTIFICATE-----\nMIIDNTCCAh2gAwIBAgIRALRetnpcTo9O3V2fAK3ix+c\n-----END CERTIFICATE-----\n",
                         "type": "string"
                       },
-                      "URL": {
+                      "url": {
                         "example": "aa60eexample.us-west-2.elb.amazonaws.com",
                         "type": "string"
                       }
@@ -1095,11 +1095,11 @@
                 "properties": {
                   "connection": {
                     "properties": {
-                      "CA": {
+                      "ca": {
                         "example": "-----BEGIN CERTIFICATE-----\nMIIDNTCCAh2gAwIBAgIRALRetnpcTo9O3V2fAK3ix+c\n-----END CERTIFICATE-----\n",
                         "type": "string"
                       },
-                      "URL": {
+                      "url": {
                         "example": "aa60eexample.us-west-2.elb.amazonaws.com",
                         "type": "string"
                       }
@@ -2667,16 +2667,16 @@
                   },
                   "oidc": {
                     "properties": {
-                      "Code": {
+                      "code": {
                         "type": "string"
                       },
-                      "ProviderID": {
+                      "providerID": {
                         "example": "4yJ3n3D8E2",
                         "format": "uid",
                         "pattern": "[\\da-zA-HJ-NP-Z]{1,11}",
                         "type": "string"
                       },
-                      "RedirectURL": {
+                      "redirectURL": {
                         "type": "string"
                       }
                     },
@@ -2689,10 +2689,10 @@
                   },
                   "passwordCredentials": {
                     "properties": {
-                      "Email": {
+                      "email": {
                         "type": "string"
                       },
-                      "Password": {
+                      "password": {
                         "type": "string"
                       }
                     },

diff --git a/internal/server/openapi.go b/internal/server/openapi.go
@@ -206,7 +206,7 @@ func buildProperty(f reflect.StructField, t, parent reflect.Type, parentSchema *
 
 		for i := 0; i < t.NumField(); i++ {
 			f2 := t.Field(i)
-			s.Properties[f2.Name] = buildProperty(f2, f2.Type, t, s)
+			s.Properties[getFieldName(f2, t)] = buildProperty(f2, f2.Type, t, s)
 		}
 	}
 

diff --git a/ui/store/AuthContext.js b/ui/store/AuthContext.js
@@ -82,7 +82,7 @@ export const AuthContextProvider = ({ children }) => {
 
   const redirectToDashboard = async (loginInfor) => {
     setUser({
-      id: loginInfor.polymorphicId,
+      id: loginInfor.polymorphicID,
       name: loginInfor.name
     })
     setAuthReady(true)