API V5 - Re-jig of basecamps/surveys

[gregmalcolm]

Ok, I admit it, the Basecamps idea is flawed. Explorers don't want to explicitly plant "basecamp" flags when exploring and making basecamps optional messes with my ability to finish implementing scientific surveys in the frontend app. I should have just stuck with how the Monster does it (Surveys and Logs). I'm going to move over to something like that but not going to use those exact names though for coding convenience.

API V3 will be retired. API V5 will have the following changes:

Survey Corrections

• Rename: Basecamps -> SurveySheets
• Rename: Surveys -> SurveyItems
• SurveyItems must have SurveySheets as the parent id.
• WorldId will be removed from SurveySheets.
• Existing SurveysItems will have SurveySheets generated for them.
• SurveySheets will have a Commander rather than an Updater, because a commander will owner that data.
• SurveySheet name will not be a required field
• Surveyed by, surveyed at, error_flag, error_description, error_updater, ed_version, notes and image_url will live in SurveySheets only. In other words SurveyItems is just for materials and resource type.

Ring mining support

• Add ring_type to SurveySheets. Types are:
  • blank (not a ring)
  • Metallic
  • Rocky
  • Icy
  • Metal Rich
• SurveySheets will need to support Star and World surveys. We could use polymorphism to solve this, but might be a little easier to consume if we just add a "body_type" and a star_id. body_type must be "World" or "Star" and will decide which parent id gets used.

Other

• Dropping resource type of BINARY/AGGREGATED. IsNumeric field decides if it's a checkbox of numeric.
• Adding is_scientific attribute which will determine if theres one SurveyItem or multiple in a SurveySheet.

Don't forget

• Update Monster importer to support all this
• Have a rake file ready to convert data from v4 to v5
• Update wiki
• Update EDDiscovery to use v5

[BloodyRain2k]

A material search function on the api end would be nice.

[gregmalcolm]

@BloodyRain2k Agreed!

[gregmalcolm]

Soemthing else for v5: Need to start tagging the source of data on all important records. Right now this could be "EDMaterializer", "DW Spreadsheet" (monster spreadsheet) or "EDDB".