feat: more fields for titles and refactored schemas

api/api.gen.go

@@ -34,6 +34,21 @@ const (
 // ReleaseSeason Title release season
 type ReleaseSeason string
 
+// Studio defines model for Studio.
+type Studio struct {
+	Description *string `json:"description,omitempty"`
+	Id          *int64  `json:"id,omitempty"`
+	Name        *string `json:"name,omitempty"`
+	PosterId    *int64  `json:"poster_id,omitempty"`
+	PosterPath  *string `json:"poster_path,omitempty"`
+}
+
+// Tag A localized tag: keys are language codes (ISO 639-1), values are tag names
+type Tag map[string]string
+
+// Tags Array of localized tags
+type Tags = []Tag
+
 // Title defines model for Title.
 type Title struct {
 	EpisodesAired *int32              `json:"episodes_aired,omitempty"`
@@ -41,7 +56,7 @@ type Title struct {
 	EpisodesLen   *map[string]float64 `json:"episodes_len,omitempty"`
 
 	// Id Unique title ID (primary key)
-	Id          *int64   `json:"id,omitempty"`
+	Id          int64    `json:"id"`
 	PosterId    *int64   `json:"poster_id,omitempty"`
 	Rating      *float64 `json:"rating,omitempty"`
 	RatingCount *int32   `json:"rating_count,omitempty"`
@@ -49,11 +64,13 @@ type Title struct {
 	// ReleaseSeason Title release season
 	ReleaseSeason *ReleaseSeason `json:"release_season,omitempty"`
 	ReleaseYear   *int32         `json:"release_year,omitempty"`
-	StudioId      *int64         `json:"studio_id,omitempty"`
+	Studio        *Studio        `json:"studio,omitempty"`
-	StudioName    *string        `json:"studio_name,omitempty"`
+
+	// Tags Array of localized tags
+	Tags Tags `json:"tags"`
 
 	// TitleNames Localized titles. Key = language (ISO 639-1), value = list of names
-	TitleNames *map[string][]string `json:"title_names,omitempty"`
+	TitleNames map[string][]string `json:"title_names"`
 
 	// TitleStatus Title status
 	TitleStatus          *TitleStatus           `json:"title_status,omitempty"`
@@ -201,20 +218,20 @@ func (a *Title) UnmarshalJSON(b []byte) error {
 		delete(object, "release_year")
 	}
 
-	if raw, found := object["studio_id"]; found {
+	if raw, found := object["studio"]; found {
-		err = json.Unmarshal(raw, &a.StudioId)
+		err = json.Unmarshal(raw, &a.Studio)
 		if err != nil {
-			return fmt.Errorf("error reading 'studio_id': %w", err)
+			return fmt.Errorf("error reading 'studio': %w", err)
 		}
-		delete(object, "studio_id")
+		delete(object, "studio")
 	}
 
-	if raw, found := object["studio_name"]; found {
+	if raw, found := object["tags"]; found {
-		err = json.Unmarshal(raw, &a.StudioName)
+		err = json.Unmarshal(raw, &a.Tags)
 		if err != nil {
-			return fmt.Errorf("error reading 'studio_name': %w", err)
+			return fmt.Errorf("error reading 'tags': %w", err)
 		}
-		delete(object, "studio_name")
+		delete(object, "tags")
 	}
 
 	if raw, found := object["title_names"]; found {
@@ -273,11 +290,9 @@ func (a Title) MarshalJSON() ([]byte, error) {
 		}
 	}
 
-	if a.Id != nil {
+	object["id"], err = json.Marshal(a.Id)
-		object["id"], err = json.Marshal(a.Id)
+	if err != nil {
-		if err != nil {
+		return nil, fmt.Errorf("error marshaling 'id': %w", err)
-			return nil, fmt.Errorf("error marshaling 'id': %w", err)
-		}
 	}
 
 	if a.PosterId != nil {
@@ -315,25 +330,21 @@ func (a Title) MarshalJSON() ([]byte, error) {
 		}
 	}
 
-	if a.StudioId != nil {
+	if a.Studio != nil {
-		object["studio_id"], err = json.Marshal(a.StudioId)
+		object["studio"], err = json.Marshal(a.Studio)
 		if err != nil {
-			return nil, fmt.Errorf("error marshaling 'studio_id': %w", err)
+			return nil, fmt.Errorf("error marshaling 'studio': %w", err)
 		}
 	}
 
-	if a.StudioName != nil {
+	object["tags"], err = json.Marshal(a.Tags)
-		object["studio_name"], err = json.Marshal(a.StudioName)
+	if err != nil {
-		if err != nil {
+		return nil, fmt.Errorf("error marshaling 'tags': %w", err)
-			return nil, fmt.Errorf("error marshaling 'studio_name': %w", err)
-		}
 	}
 
-	if a.TitleNames != nil {
+	object["title_names"], err = json.Marshal(a.TitleNames)
-		object["title_names"], err = json.Marshal(a.TitleNames)
+	if err != nil {
-		if err != nil {
+		return nil, fmt.Errorf("error marshaling 'title_names': %w", err)
-			return nil, fmt.Errorf("error marshaling 'title_names': %w", err)
-		}
 	}
 
 	if a.TitleStatus != nil {

api/openapi.yaml

@@ -2,8 +2,10 @@ openapi: 3.1.1
 info:
   title: Titles, Users, Reviews, Tags, and Media API
   version: 1.0.0
+
 servers:
   - url: /api/v1
+
 paths:
   /title:
     get:
@@ -63,6 +65,7 @@ paths:
           description: Request params are not correct
         '500':
           description: Unknown server error
+
 #   /title/{title_id}:
 #     get:
 #       summary: Get title description
@@ -569,6 +572,7 @@ components:
         - finished
         - ongoing
         - planned
+
     ReleaseSeason:
       type: string
       description: Title release season
@@ -577,6 +581,7 @@ components:
         - spring
         - summer
         - fall
+
     UserTitleStatus:
       type: string
       description: User's title status
@@ -585,8 +590,57 @@ components:
         - planned
         - dropped
         - in-progress
+
+    Review:
+      type: object
+      additionalProperties: true
+
+    Tag:
+      type: object
+      description: "A localized tag: keys are language codes (ISO 639-1), values are tag names"
+      additionalProperties:
+        type: string
+      example:
+        en: "Shojo"
+        ru: "Сёдзё"
+        ja: "少女"
+
+    Tags:
+      type: array
+      description: "Array of localized tags"
+      items:
+        $ref: '#/components/schemas/Tag'
+      example:
+        - en: "Shojo"
+          ru: "Сёдзё"
+          ja: "少女"
+        - en: "Shounen"
+          ru: "Сёнен"
+          ja: "少年"
+
+    Studio:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        poster_id:
+          type: integer
+          format: int64
+        poster_path:
+          type: string
+        description:
+          type: string
+
+
     Title:
       type: object
+      required:
+        - id
+        - title_names
+        - tags
       properties:
         id:
           type: integer
@@ -607,11 +661,10 @@ components:
             en: ["Attack on Titan", "AoT"]
             ru: ["Атака титанов", "Титаны"]
             ja: ["進撃の巨人"]
-        studio_id:
+        studio:
-          type: integer
+          $ref: '#/components/schemas/Studio'
-          format: int64
+        tags:
-        studio_name:
+          $ref: '#/components/schemas/Tags'
-          type: string
         poster_id: 
           type: integer
           format: int64
@@ -640,6 +693,7 @@ components:
             type: number
             format: double
       additionalProperties: true
+
     User:
       type: object
       properties:
@@ -683,12 +737,7 @@ components:
         - user_id
         - nickname
         # - creation_date
+
     UserTitle:
       type: object
       additionalProperties: true
-    Review:
-      type: object
-      additionalProperties: true
-    Tag:
-      type: object
-      additionalProperties: true