Simplify and improve variants output to be more useful

[alistair3149]

This is not only about improvements on variants, but also a feature request for set items.
I include them together as they are somewhat related.

Problem

• Variant items do not have any info on other variant items, requiring additional API request to find all variant items.
• base_variant is included regardless of whether variants is included as relation.
• Unnecessary variant item data (such as type, sub_type, manufacturer, etc.) are the same across variant items.
• Variant names (e.g. Aqua) are desired for display purposes.
• Set items (e.g. finding other pieces of an armor piece) are desired.

Proposed solution

We can add a related_items key that incorporate all the related items of the current item.
It can be set as a valid_relations so it can be selectively included to reduce the size of the API request.

Example output for Lynx Arms Red:

{
	"related_items": {
		"set_name": "Lynx Arms",
		"base_item": {
			"uuid": "48609392-c78c-4909-8714-387900059785",
			"name": "Lynx Arms Base",
			"variant_name": "Base",
			"link": "https://api.star-citizen.wiki/api/v2/items/48609392-c78c-4909-8714-387900059785"
		},
		"variant_items": [
			{
				"uuid": "07244e7f-81af-428e-a49e-ae1b9a940997",
				"name": "Lynx Arms Aqua",
				"variant_name": "Aqua",
				"link": "https://api.star-citizen.wiki/api/v2/items/07244e7f-81af-428e-a49e-ae1b9a940997"
			},
			{
				"uuid": "fd7ca539-4462-43b4-b3b4-8f6246dc0362",
				"name": "Lynx Arms Black",
				"variant_name": "Black",
				"link": "https://api.star-citizen.wiki/api/v2/items/fd7ca539-4462-43b4-b3b4-8f6246dc0362"
			}

		],
		"set_items": [
			{
				"uuid": "c94881f7-6ce1-4fb3-8bd7-018e71d1d19a",
				"name": "Oracle Helmet Red",
				"type": "Char_Armor_Helmet",
				"sub_type": "Light",
				"link": "https://api.star-citizen.wiki/api/v2/items/c94881f7-6ce1-4fb3-8bd7-018e71d1d19a"
			},
			{
				"uuid": "f345cdb7-287a-44aa-a588-0331848ac656",
				"name": "Lynx Core Red",
				"type": "Char_Armor_Core",
				"sub_type": "Light",
				"link": "https://api.star-citizen.wiki/api/v2/items/f345cdb7-287a-44aa-a588-0331848ac656"
			},
			{
				"uuid": "60d89692-e306-46fb-8259-7bcca61f7deb",
				"name": "Lynx Legs Red",
				"type": "Char_Armor_Legs",
				"sub_type": "Light",
				"link": "https://api.star-citizen.wiki/api/v2/items/60d89692-e306-46fb-8259-7bcca61f7deb"
			}
		]
	}
}

base_item, variant_items, and set_items contain item objects that uses the following schema:

{
	"uuid": "UUID of the item",
	"name": "Name of the item",
	"variant_name": "Variant name of the item, where the set_name is removed from the item name. Only included in variant_items",
	"type": "Type of the item. Only included in set_items",
	"sub_type": "Subtype of the item. Only included in set_items",
	"link": "URL of the API"
}

set_items represents a list of related items in the same set.

For clothing and armor, that will be other items that share the similar class names (e.g. Oracle Helmet Red (outlaw_legacy_armor_light_helmet_01_04_02) is in the same set as Lynx Arms Red (outlaw_legacy_armor_light_arms_01_04_02)).

It can be expanded to other item types in the future, like having different sizes of a vehicle component (e.g. M4A Cannon, M5A Cannon, etc.)

It can probably be found by checking if the class name exists:

For example, Lynx Arms Dark Red has a class name of outlaw_legacy_armor_light_arms_01_04_13.
Replacing the arms part with helmet would yield outlaw_legacy_armor_light_helmet_01_04_13, which is Oracle Helmet Dark Red.

With this method, we might have to hardcode what are the possible set item types.
There might be better way to handle this, but the class name method works.

variant_name and set_name can be found by comparing the names of the item,
it might be beneficial for build up a list of possible variant names for performance reason too.

[octfx]

I've started some initial work on this, this new output can be included with ?include=related_items

Only did manual tests so there will be instances where this does not match

Sample output for Lynx Arms Red:

        "related_items": {
            "set_name": "Lynx Arms",
            "base_item": {
                "uuid": "48609392-c78c-4909-8714-387900059785",
                "name": "Lynx Arms Base",
                "link": "http:\/\/localhost:8000\/api\/v2\/items\/48609392-c78c-4909-8714-387900059785",
                "variant_name": "Base"
            },
            "variant_items": [
                {
                    "uuid": "41314061-7d4d-4a40-b642-d4736a32565a",
                    "name": "Lynx Arms Cold Steel",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/41314061-7d4d-4a40-b642-d4736a32565a",
                    "variant_name": "Cold Steel"
                },
                {
                    "uuid": "05ff08a5-d702-4f47-9e8a-7f6108132ccc",
                    "name": "Lynx Arms Draas",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/05ff08a5-d702-4f47-9e8a-7f6108132ccc",
                    "variant_name": "Draas"
                },
                {
                    "uuid": "d7eed5fc-86c9-455b-a816-1db0a5e77c81",
                    "name": "Lynx Arms Firebrick",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/d7eed5fc-86c9-455b-a816-1db0a5e77c81",
                    "variant_name": "Firebrick"
                },
                {
                    "uuid": "00c35078-4161-468c-8cd2-7bad6ba58992",
                    "name": "Lynx Arms Sandstorm",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/00c35078-4161-468c-8cd2-7bad6ba58992",
                    "variant_name": "Sandstorm"
                },
                {
                    "uuid": "503a2df0-f032-431d-8d4a-3895d65c32af",
                    "name": "Lynx Arms Lichen",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/503a2df0-f032-431d-8d4a-3895d65c32af",
                    "variant_name": "Lichen"
                },
                {
                    "uuid": "f1194db3-4bf8-402f-9565-54b7ae8f401b",
                    "name": "Lynx Arms Red",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/f1194db3-4bf8-402f-9565-54b7ae8f401b",
                    "variant_name": "Red"
                },
                {
                    "uuid": "ae3019a1-4f0f-4a41-8451-8b6b84c632e8",
                    "name": "Lynx Arms Orange",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/ae3019a1-4f0f-4a41-8451-8b6b84c632e8",
                    "variant_name": "Orange"
                },
                {
                    "uuid": "bc64ccce-a776-463e-bf6c-ebf17a9e17d9",
                    "name": "Lynx Arms Yellow",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/bc64ccce-a776-463e-bf6c-ebf17a9e17d9",
                    "variant_name": "Yellow"
                },
                {
                    "uuid": "bb24483b-8822-4325-9368-0507d45e1be8",
                    "name": "Lynx Arms Green",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/bb24483b-8822-4325-9368-0507d45e1be8",
                    "variant_name": "Green"
                },
                {
                    "uuid": "c88b3131-7cad-4e90-a288-ca6be6b9328d",
                    "name": "Lynx Arms Seagreen",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/c88b3131-7cad-4e90-a288-ca6be6b9328d",
                    "variant_name": "Seagreen"
                },
                {
                    "uuid": "e2070edb-01ac-447d-a76e-eba5ef2ad05d",
                    "name": "Lynx Arms Blue",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/e2070edb-01ac-447d-a76e-eba5ef2ad05d",
                    "variant_name": "Blue"
                },
                {
                    "uuid": "1e48d009-30aa-4657-8e7e-b90105868b02",
                    "name": "Lynx Arms Purple",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/1e48d009-30aa-4657-8e7e-b90105868b02",
                    "variant_name": "Purple"
                },
                {
                    "uuid": "ae8e946a-8c02-41ff-a2b1-273dbec6c571",
                    "name": "Lynx Arms Violet",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/ae8e946a-8c02-41ff-a2b1-273dbec6c571",
                    "variant_name": "Violet"
                },
                {
                    "uuid": "fd7ca539-4462-43b4-b3b4-8f6246dc0362",
                    "name": "Lynx Arms Black",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/fd7ca539-4462-43b4-b3b4-8f6246dc0362",
                    "variant_name": "Black"
                },
                {
                    "uuid": "dbee9f04-0939-4657-9f8a-96a3c99b7db5",
                    "name": "Lynx Arms Dark Red",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/dbee9f04-0939-4657-9f8a-96a3c99b7db5",
                    "variant_name": "Dark Red"
                },
                {
                    "uuid": "7d72580c-23a2-4258-9bd5-4275da1f08c8",
                    "name": "Lynx Arms Sienna",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/7d72580c-23a2-4258-9bd5-4275da1f08c8",
                    "variant_name": "Sienna"
                },
                {
                    "uuid": "64d4fc3f-1682-43a8-bb99-d45ca9a76018",
                    "name": "Lynx Arms (Modified)",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/64d4fc3f-1682-43a8-bb99-d45ca9a76018",
                    "variant_name": "(Modified)"
                },
                {
                    "uuid": "acbd923b-42d3-4993-bb47-ab6a1d7ddac5",
                    "name": "Lynx Arms White",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/acbd923b-42d3-4993-bb47-ab6a1d7ddac5",
                    "variant_name": "White"
                },
                {
                    "uuid": "de759022-125e-42dc-8b8e-c8739bd6a776",
                    "name": "Lynx Arms Grey",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/de759022-125e-42dc-8b8e-c8739bd6a776",
                    "variant_name": "Grey"
                },
                {
                    "uuid": "e8441c9a-20a4-4661-b566-f46190ad4d3e",
                    "name": "Lynx Arms Tan",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/e8441c9a-20a4-4661-b566-f46190ad4d3e",
                    "variant_name": "Tan"
                },
                {
                    "uuid": "7729b33e-1167-4a10-b70c-45b9e7774f41",
                    "name": "Lynx Arms Dark Green",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/7729b33e-1167-4a10-b70c-45b9e7774f41",
                    "variant_name": "Dark Green"
                },
                {
                    "uuid": "7ef5780d-9ced-47ad-b70b-ba0755dacb44",
                    "name": "Lynx Arms Aqua",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/7ef5780d-9ced-47ad-b70b-ba0755dacb44",
                    "variant_name": "Aqua"
                },
                {
                    "uuid": "f7edd487-2a8e-4a24-bb0e-cfd013827c7a",
                    "name": "Lynx Arms Twilight",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/f7edd487-2a8e-4a24-bb0e-cfd013827c7a",
                    "variant_name": "Twilight"
                },
                {
                    "uuid": "0029eeb3-9062-47d6-82bd-27246f31427b",
                    "name": "Lynx Arms Imperial",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/0029eeb3-9062-47d6-82bd-27246f31427b",
                    "variant_name": "Imperial"
                },
                {
                    "uuid": "32c5e55b-2504-493f-94cf-e8482db6226f",
                    "name": "Lynx Arms Olive",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/32c5e55b-2504-493f-94cf-e8482db6226f",
                    "variant_name": "Olive"
                },
                {
                    "uuid": "f15c609c-3904-4d72-97ba-b89b34363316",
                    "name": "Lynx Arms Base",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/f15c609c-3904-4d72-97ba-b89b34363316",
                    "variant_name": "Base"
                },
                {
                    "uuid": "6708804f-b781-40b7-b691-608f83641aec",
                    "name": "Lynx Arms Base",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/6708804f-b781-40b7-b691-608f83641aec",
                    "variant_name": "Base"
                },
                {
                    "uuid": "1db80d63-12a7-4940-8705-8e0945ebcacb",
                    "name": "Lynx Arms Base",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/1db80d63-12a7-4940-8705-8e0945ebcacb",
                    "variant_name": "Base"
                },
                {
                    "uuid": "faf830ac-82ec-438e-ba21-7c85a292c788",
                    "name": "Lynx Arms Base",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/faf830ac-82ec-438e-ba21-7c85a292c788",
                    "variant_name": "Base"
                },
                {
                    "uuid": "a88fda49-54dc-4b2b-8e19-33559c29df55",
                    "name": "Lynx Arms Base",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/a88fda49-54dc-4b2b-8e19-33559c29df55",
                    "variant_name": "Base"
                }
            ],
            "set_items": [
                {
                    "uuid": "8b7770f5-b664-466b-80d8-1ed97923c0be",
                    "name": "Oracle Helmet Base",
                    "type": "Char_Armor_Helmet",
                    "sub_type": "Light",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/8b7770f5-b664-466b-80d8-1ed97923c0be"
                },
                {
                    "uuid": "7408404d-d1f9-4941-bf7f-93886fac4bc9",
                    "name": "Lynx Core Base",
                    "type": "Char_Armor_Torso",
                    "sub_type": "Light",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/7408404d-d1f9-4941-bf7f-93886fac4bc9"
                },
                {
                    "uuid": "b75d74b1-312f-4d47-aec6-f9f767cf64a5",
                    "name": "Lynx Legs Base",
                    "type": "Char_Armor_Legs",
                    "sub_type": "Light",
                    "link": "http:\/\/localhost:8000\/api\/v2\/items\/b75d74b1-312f-4d47-aec6-f9f767cf64a5"
                }
            ]
        },

[alistair3149]

Thank you so much for implementing that!
I will take a look later and hopefully implements something with it on the wiki.