add comments

internal/gtsmodel/application.go

@@ -18,13 +18,38 @@
 
 package gtsmodel
 
+import "github.com/gotosocial/gotosocial/pkg/mastotypes"
+
+// Application represents an application that can perform actions on behalf of a user.
+// It is used to authorize tokens etc, and is associated with an oauth client id in the database.
 type Application struct {
-	ID           string `pg:"type:uuid,default:gen_random_uuid(),pk,notnull"`
+	// id of this application in the db
-	Name         string
+	ID string `pg:"type:uuid,default:gen_random_uuid(),pk,notnull"`
-	Website      string
+	// name of the application given when it was created (eg., 'tusky')
-	RedirectURI  string `json:"redirect_uri"`
+	Name string
-	ClientID     string `json:"client_id"`
+	// website for the application given when it was created (eg., 'https://tusky.app')
-	ClientSecret string `json:"client_secret"`
+	Website string
-	Scopes       string `json:"scopes"`
+	// redirect uri requested by the application for oauth2 flow
-	VapidKey     string `json:"vapid_key"`
+	RedirectURI string
+	// id of the associated oauth client entity in the db
+	ClientID string
+	// secret of the associated oauth client entity in the db
+	ClientSecret string
+   // scopes requested when this app was created
+	Scopes       string
+   // a vapid key generated for this app when it was created
+	VapidKey     string
+}
+
+// ToMastotype returns this application as a mastodon api type, ready for serialization
+func (a *Application) ToMastotype() *mastotypes.Application {
+	return &mastotypes.Application{
+		ID:           a.ID,
+		Name:         a.Name,
+		Website:      a.Website,
+		RedirectURI:  a.RedirectURI,
+		ClientID:     a.ClientID,
+		ClientSecret: a.ClientSecret,
+		VapidKey:     a.VapidKey,
+	}
 }