ID Array Conventions

Open itshouldntdothis opened this issue 8 years ago • 1 comments

Conventions

Description

Where an array of ids is returned inside an object define them as ids.

Example

stargates > stargate_ids
moons > moon_ids

{
  "planets": [
    {
      "planet_id": 40000041,
      "moons": [ 40000042 ]
    },
    {
      "planet_id": 40000123,
      "moons": [ 40000125, 40000127, 40000128 ]
    }
  ],
  "stargates": [ 50000342, 50000343, 50000344, 50000345 ],
  ...otherFields
}
=>
{
  "planets": [
    {
      "planet_id": 40000041,
      "moon_ids": [ 40000042 ]
    },
    {
      "planet_id": 40000123,
      "moon_ids": [ 40000125, 40000127, 40000128 ]
    }
  ],
  "stargate_ids": [ 50000342, 50000343, 50000344, 50000345 ],
  ...otherFields
}

Routes / Resolution

[ ] GET /v2/characters/{character_id}/clones/

implants > implant_ids

[ ] GET /v1/incursions/

infested_solar_systems > infested_solar_system_ids

[ ] GET /v1/characters/{character_id}/mail/

labels > label_ids

[ ] GET /v1/characters/{character_id}/mail/{mail_id}/

SEE ABOVE

[ ] PUT /v1/characters/{character_id}/mail/{mail_id}/

BODY: SEE ABOVEx2

[ ] GET /v1/markets/groups/{market_group_id}/

types > type_ids

[ ] GET /v1/opportunities/groups/{group_id}/

connected_groups > connected_group_ids
required_tasks > required_task_ids

[ ] GET /v2/characters/{character_id}/search/

agent > agent_ids
alliance > alliance_ids
character > character_ids
constellation > constellation_ids
corporation > corporation_ids
faction > faction_ids
inventorytype > inventorytype_ids
region > region_ids, solarsystem > solarsystem_ids
station > station_ids
wormhole > wormhole_ids

[ ] GET /v1/search/

SEE ABOVE

[ ] GET /v1/universe/categories/{category_id}/

groups > group_ids

[ ] GET /v1/universe/constellations/{constellation_id}/

systems > system_ids

[ ] GET /v1/universe/groups/{group_id}/

types > type_ids

[ ] GET /v1/universe/regions/{region_id}/

constellations > constellation_ids

[ ] GET /v2/universe/systems/{system_id}/

stargates > stargate_ids
moons > moon_ids

May 07 '17 18:05 itshouldntdothis

GitHub doesn't seem to have a reaction smiley for expressing ambivalence, so this comment will have to do: While I don't consider this convention necessary, or particularly desirable, I do not have any strong feelings against it either.

May 03 '18 16:05 CarbonAlabel