feat: move isLocalized from query to schema property

Closes #151

docs/changelog/0.4.0.md

@@ -24,6 +24,7 @@ _Not Released Yet_
     - Added support for `/v2/guild/search`. [[GH-91](https://github.com/GW2ToolBelt/api-generator/issues/91)]
     - Added support for `/v2/recipes/search`. [[GH-127](https://github.com/GW2ToolBelt/api-generator/issues/127)]
 - Reworked library entry-points and split them into available types and queries.
+- Moved `isLocalized` from `APIQuery` to `SchemaType` to support better representation of the underlying data. [[GH-151](https://github.com/GW2ToolBelt/api-generator/issues/151)]
 
 #### Fixes
 
@@ -32,6 +33,7 @@ _Not Released Yet_
     - Changed `ID` type for `/v2/finishers` from `STRING` to `INTEGER`.
     - Changed `ID` type for `/v2/minis` from `STRING` to `INTEGER`.
     - Changed `ID` type for `/v2/pets` from `STRING` to `INTEGER`.
+    - Added missing `description` field to `/v2/pvp/heroes`.
     - Updated a wrong record description for `/v2/quaggans`.
     - Changed `ID` type for `/v2/quests` from `STRING` to `INTEGER`.
     - Changed `ID` type for `/v2/recipes` from `STRING` to `INTEGER`.

src/main/kotlin/com/gw2tb/apigen/internal/dsl/dsl.kt

@@ -350,8 +350,6 @@ internal sealed class APIQueryBuilder<Q : APIQuery, T : APIType>(private val cre
 
     var summary: String = ""
 
-    var isLocalized: Boolean = false
-
     var cache: Duration? = null
     var security: Set<TokenScope>? = null
 
@@ -431,7 +429,6 @@ internal sealed class APIQueryBuilder<Q : APIQuery, T : APIType>(private val cre
                 summary = summary,
                 pathParameters = pathParameters,
                 queryParameters = queryParameters,
-                isLocalized = isLocalized,
                 cache = cache,
                 schema = schema[V2SchemaVersion.V2_SCHEMA_CLASSIC]!!
             )
@@ -485,7 +482,6 @@ internal sealed class APIQueryBuilder<Q : APIQuery, T : APIType>(private val cre
             pathParameters = pathParameters,
             queryParameters = queryParameters ?: this.queryParameters,
             queryDetails = queryDetails,
-            isLocalized = isLocalized && (queryDetails?.queryType != QueryType.IDs),
             cache = cache,
             since = since,
             until = until,

src/main/kotlin/com/gw2tb/apigen/internal/dsl/schema.kt

@@ -217,6 +217,9 @@ internal class SchemaRecordBuilder<T : APIType>(val name: String) : SchemaBuilde
     /** Marks a deprecated property. */
     val deprecated = Modifiers.deprecated
 
+    /** Marks a localized property. */
+    val localized = Modifiers.localized
+
     /** Marks an optional property. */
     val optional = Modifiers.optional
 
@@ -283,6 +286,12 @@ internal class SchemaRecordPropertyBuilder(
             field = value
         }
 
+    var isLocalized = false
+        set(value) {
+            check(isUnused)
+            field = value
+        }
+
     var optionality: Optionality? = null
         set(value) {
             check(isUnused)
@@ -322,6 +331,7 @@ internal class SchemaRecordPropertyBuilder(
             description = description,
             optionality = optionality ?: Optionality.REQUIRED,
             isDeprecated = isDeprecated,
+            isLocalized = isLocalized,
             since = since,
             until = until,
             serialName = serialName ?: propertyName.toLowerCase(),
@@ -355,6 +365,12 @@ internal object Modifiers {
 
     }
 
+    val localized = object : PropertyModifier() {
+        override fun applyTo(property: SchemaRecordPropertyBuilder) {
+            property.isLocalized = true
+        }
+    }
+
     val optional = object : PropertyModifier() {
         override fun applyTo(property: SchemaRecordPropertyBuilder) {
             property.optionality = Optionality.OPTIONAL

src/main/kotlin/com/gw2tb/apigen/internal/spec/GW2v1.kt

@@ -47,25 +47,23 @@ internal val GW2v1 = GW2APIVersion({ APIVersionBuilder.V1() }) {
     }
     "/map_names"(endpoint = "MapNames") {
         summary = "Returns information about maps."
-        isLocalized = true
 
         schema(array(
             description = "the available maps",
             items = record(name = "MapName", description = "Information about a map.") {
                 CamelCase("id").."ID"(INTEGER, "the map's ID")
-                "Name"(STRING, "the map's name")
+                localized.."Name"(STRING, "the map's name")
             }
         ))
     }
     "/skin_details"(endpoint = "SkinDetails") {
         summary = "Returns information about the skins in the game."
         cache = 1.hours
-        isLocalized = true
 
         queryParameter("SkinID", INTEGER, "the amount to exchange", key = "skin_id")
         schema(conditional("SkinDetails", "Information about a skin.", interpretationInNestedProperty = true, sharedConfigure = {
             SerialName("skin_id").."SkinID"(INTEGER, "")
-            "Name"(STRING, "the skin's localized name")
+            localized.."Name"(STRING, "the skin's localized name")
             "Type"(STRING, "the skin's type")
             "Rarity"(STRING, "the skin's rarity")
             "Flags"(array(STRING), "additional skin flags (ShowInWardrobe, NoCost, HideIfLocked, OverrideRarity)")
@@ -115,13 +113,12 @@ internal val GW2v1 = GW2APIVersion({ APIVersionBuilder.V1() }) {
     }
     "/world_names"(endpoint = "WorldNames") {
         summary = "Returns information about the available worlds (or servers)."
-        isLocalized = true
 
         schema(array(
             description = "the available worlds",
             items = record(name = "WorldName", description = "Information about an available world (or server).") {
                 CamelCase("id").."ID"(INTEGER, "the ID of the world")
-                "Name"(STRING, "the name of the world")
+                localized.."Name"(STRING, "the name of the world")
             }
         ))
     }