Consistency: solar_system_id vs system_id

[Blacksmoke16]

A quick look through the swagger spec shows that 17 endpoints are using system_id and 13 are using solar_system_id. I propose we decide on one and use that consistently throughout all the endpoints.

I can compile a list of ones that would need to change once we decide on which to use.

I personally would use system_id

solar_system_id

• [ ] /v1/characters/{character_id}/location/
• [ ] /v1/characters/{character_id}/mining/
• [ ] /v1/characters/{character_id}/planets/
• [ ] /v1/fleets/{fleet_id}/members/
• [ ] /v1/industry/facilities/
• [ ] /v1/industry/systems/
• [ ] /v1/killmails/{killmail_id}/{killmail_hash}/
• [ ] /v1/sovereignty/campaigns/
• [ ] /v1/sovereignty/structures/
• [ ] /v1/universe/stars/{star_id}/
• [ ] /v2/fw/systems/
• [ ] /v2/universe/factions/
• [ ] /v2/universe/structures/{structure_id}/

system_id

• [ ] /v1/corporations/{corporation_id}/customs_offices/
• [ ] /v1/corporations/{corporation_id}/facilities/
• [ ] /v1/corporations/{corporation_id}/starbases/
• [ ] /v1/markets/{region_id}/orders/
• [ ] /v1/sovereignty/map/
• [ ] /v1/universe/asteroid_belts/{asteroid_belt_id}/
• [ ] /v1/universe/moons/{moon_id}/
• [ ] /v1/universe/planets/{planet_id}/
• [ ] /v1/universe/stargates/{stargate_id}/
• [ ] /v1/universe/system_jumps/
• [ ] /v2/corporations/{corporation_id}/structures/
• [ ] /v2/universe/stations/{station_id}/
• [ ] /v2/universe/system_kills/
• [ ] /v4/universe/systems/{system_id}/
• [ ] /v1/corporations/{corporation_id}/starbases/{starbase_id}/ (used as a param)

[GoldenGnu]

system_id have my vote too

[ccp-zoetrope]

system_id is preferred moving forward. Thanks for flagging this.

[ghost]

I recommend against "system_id" for exactly the reason that caused this bug: https://github.com/esi/esi-issues/issues/966

The word "system" generally means "a software system" in CCP code. Changing it to mean "solar system" on the ESI side risks more of the above confusion. Specificity is good.

[Blacksmoke16]

I updated the OP with endpoints that use each.

[guiguilechat]

"solar_id" would be better.

"system" is a very broad term and should not be used alone. Using it in development can lead to misunderstanding what a name stands for, or even in bugs if people are not sanitizing the names, eg when creating the structures to represent the result (System is a package in java, that represents the jvm)

"solar_system_id" is too long.

if "solar_id" can't do it, then "solar_system_id". But calling a solar system "system" is a way to include bugs later. Don't call your variable/structure/clas/etc. "system".

[kennethjor]

The systems endpoint itself returns system_id, so this should be the standard.