Bungie-net / api

Resources for the Bungie.net API
Other
1.22k stars 92 forks source link

Include milestone title in Destiny.Milestones.DestinyMilestoneContent #309

Open DeathByNukes opened 6 years ago

DeathByNukes commented 6 years ago

It would be extremely helpful if you included the actual name of a milestone in the data returned by /Destiny2/Milestones/{milestoneHash}/Content/. Loading and parsing the manifests is a huge amount of overhead just to tell clanmates in IRC what special events are currently happening.

ArkahnX commented 6 years ago

The manifest contains data such as locale specific names and descriptions to keep the API clean and locale free (For most parts of the API at least) it's unlikely names will be added to the endpoint, however there are some tools such as Destiny Plumbing that expose the manifest on the web

DeathByNukes commented 6 years ago

/Destiny2/Milestones/{milestoneHash}/Content/ is an API that appears to exclusively contain English text, so the name would not be out of place.

Example output:

{
    "about": "Nightfall Strikes are end game versions of regular Vanguard Strikes. In a Nightfall Strike, players will have to contend with special modifiers which enhance the difficulty of this Strike activity.",
    "status": "",
    "tips": [
        "The featured Nightall Strike rotates every week, following the weekly reset.",
        "The modifiers featured in the Nightfall activity also rotate every week, following the weekly reset.",
        "It is recommended that players adjust their loadout to take advantage of the modifiers of a Nightfall Strike."
    ]
}
vthornheart-bng commented 6 years ago

Ah, so that particular endpoint is a bit of a strange bird - it's got the /Content/ part of its URL to specifically indicate that it's an exception to the general rule, in that we're returning localized content (in this case, content coming from our Content Management System, which is also why this data doesn't come back in the manifests: it's freely editable in our CMS, and anything we put in the definitions could theoretically be stale as a result).

I'm not opposed - specifically for this endpoint, since its goal is to return localized text - to also return localized data here.