feat: rename 'subject' in check response to 'sub' for consistency

jaspeen · Jun 10, 2024 · 21d16fb · 21d16fb
1 parent 0fdcc05
commit 21d16fb
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/api/api_test.go b/api/api_test.go
@@ -124,7 +124,7 @@ func TestCreateApiKey(t *testing.T) {
 
  // check api key
  var checkResp struct {
- Subject string `json:"subject"`
+ Sub string `json:"sub"`
  }
  t.Run("check", func(t *testing.T) {
  w = httptest.NewRecorder()
@@ -135,7 +135,7 @@ func TestCreateApiKey(t *testing.T) {
  require.Equal(t, 200, w.Code)
  err = json.Unmarshal(w.Body.Bytes(), &checkResp)
  require.Nil(t, err)
- assert.Equal(t, "testsub", checkResp.Subject)
+ assert.Equal(t, "testsub", checkResp.Sub)
  })
 
  // validate api key
@@ -154,7 +154,7 @@ func TestCreateApiKey(t *testing.T) {
 
  router.ServeHTTP(w, req)
  require.Equal(t, 200, w.Code)
- assert.Equal(t, "testsub", checkResp.Subject)
+ assert.Equal(t, "testsub", checkResp.Sub)
  })
 
  // get api key

diff --git a/api/check.go b/api/check.go
@@ -48,17 +48,17 @@ func (a *Api) checkAndGetApiKeyData(c *gin.Context) (*queries.GetApiKeyForVerify
 }
 
 type checkResponse struct {
- Id  string `json:"id"`
- Subject string `json:"subject"`
- Extra  json.RawMessage `json:"extra,omitempty"`
+ Id string `json:"id"`
+ Sub string `json:"sub"`
+ Extra json.RawMessage `json:"extra,omitempty"`
 }
 
 func (a *Api) Check(c *gin.Context) {
  apiKeyData, err := a.checkAndGetApiKeyData(c)
  if err != nil {
  respondUnauthorized(c)
  } else {
- c.JSON(200, checkResponse{Id: strconv.Itoa(int(apiKeyData.ID)), Subject: apiKeyData.Sub.String, Extra: apiKeyData.Extra.RawMessage})
+ c.JSON(200, checkResponse{Id: strconv.Itoa(int(apiKeyData.ID)), Sub: apiKeyData.Sub.String, Extra: apiKeyData.Extra.RawMessage})
  }
 }
 
@@ -127,5 +127,5 @@ func (a *Api) Verify(c *gin.Context) {
  return
  }
 
- c.JSON(200, checkResponse{Id: strconv.Itoa(int(apiKeyData.ID)), Subject: apiKeyData.Sub.String, Extra: apiKeyData.Extra.RawMessage})
+ c.JSON(200, checkResponse{Id: strconv.Itoa(int(apiKeyData.ID)), Sub: apiKeyData.Sub.String, Extra: apiKeyData.Extra.RawMessage})
 }
diff --git a/deploy/charts/apikeyman/Chart.yaml b/deploy/charts/apikeyman/Chart.yaml
@@ -7,5 +7,5 @@ keywords:
  - security
 sources:
  - https://github.com/jaspeen/apikeyman
-version: 0.1.5
-appVersion: "0.1.5"
+version: 0.1.6
+appVersion: "0.1.6"