MVP: Variable Values

[zysim]

:hammer::hammer::hammer:

Model Explanation

• Value to a Variable which is in turn assignable to Categories
• Example:

  Variable with name "platform" might have values "PC", "Xbox" (ref: Discord)

  • The Variable Value's Name property will be "PC"/"Xbox"

• Actual values that are tied directly to a Run are called Run Variables (https://github.com/leaderboardsgg/leaderboard-backend/issues/113)
• Run Variables are simply the intermediary between Runs and Variable Values, holding foreign keys to link the former to the latter
• Runs are to be retrievable by calling e.g. (ref: Discord):
  • GET /category/123/runs?platform=1; OR
  • GET /category/123/runs?platform=PC

Model/Relationships

• [ ] Create model - refer to MVP
  • One Variable to one or more Variable Values
  • One Variable Value to one or more Run Variables

Controller Actions

• DELETEs are soft deletes unless explicitly specified
• Mod actions imply extra condition check to ensure related Leaderboard is modded by User must be made

• [ ] GET Variable Value Name as API with ID
• [ ] POST Variable Value as mod with:
  • Name (string);
  • Variable ID (long; fk). (Note: NOT Variable Value ID)
  • Condition: Variable assigned to Category/ies belonging to Leaderboard that is modded
• [ ] PUT Variable Value as mod with:
  • ID (long; pk);
  • Name (string);
• [ ] DELETE Variable Value as mod with:
  • ID (long; pk)
  • Other Variable Value ID (long; pk, conditional)
  • Condition: other Variable Value must belong to same Variable, if specified
  • Condition: other Variable Value must be specified if Variable is required and Runs with original Variable Value exist

Post-action Behaviours

• [ ] DELETE Variable Value, by mod and if other Variable Value ID specified:
  • All Runs assigned to original Variable Value must be reassigned to other Variable Value

[TheTedder]

Run variables are not part of MVP. See requirements for more details.