search

SpaceTradersAPI / api-docs

The API documentation for the SpaceTraders API
143 stars 35 forks source link

ShipyardTransaction.shipSymbol is confusing #68

Closed eseidel closed 9 months ago

eseidel commented 1 year ago

ShipyardTransaction:

  /// The symbol of the ship that was the subject of the transaction.
  String shipSymbol;

it actually the tradeSymbol of the Ship you just bought, not it's new shipSymbol.

Where as MarketTransaction: 

  /// The symbol of the ship that made the transaction.
  String shipSymbol;

And ShipModificationTransaction: 

  /// The symbol of the ship that made the transaction.
  String shipSymbol;

It's just that it's called "shipSymbol" when actually being a TradeSymbol and the docs being ambiguous.

eseidel commented 1 year ago

My proposal would be to rename shipSymbol to shipType in the ShipyardTransaction.

space-admiral commented 9 months ago

Good idea, I'll deprecate the property shipSymbol in favor of shipType

eseidel commented 9 months ago

I see this resolved in https://github.com/SpaceTradersAPI/api-docs/commit/32aa98a060d501f0444eaf1512b9cd0cbe13f3f1. Does that mean shipSymbol is actually the shipSymbol? :)

eseidel commented 9 months ago

I'm going to assume it is. Thank you!