Feature: V2 /rules endpoint
#560
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I have refactored the old ruleset to gamesystem. Pull in changes from staging and adjust your code to use the different ruleset wording. |
augustjohnson
requested changes
Oct 8, 2024
|
@augustjohnson Thanks for making the change from |
api_v2/models/rules.py
Outdated
There was a problem hiding this comment.
filename should be singular, rule.py.
api_v2/models/rules.py
Outdated
|
|
||
| class RuleSet(HasName, HasDescription, FromDocument): | ||
| """ | ||
| The RuleGroup model contains a set of Rules as part of a larger article, or |
There was a problem hiding this comment.
Still a reference to ruleGroup here. Edit comments.
augustjohnson
requested changes
Oct 9, 2024
augustjohnson
approved these changes
Oct 10, 2024
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR goes part way to resolving issue #544 by introducing new models and views to API V2 for returning data equivelent to the
/sectionsendpoint from V1 of the API.Wait, why
RuleGroup?Following discussion on the Open5e Discord, it was decided that the names of these endpoints should be
/rulesfor specific rules and/rulesetsfor set of rules. However, the endpoint/rulesetsis currently being used to return a list of different 'flavours' of 5e. D&D 2014, Level Up Advanced 5e, that kind of thing. It was decided that this endpoint should be renamed to/gamesystem, so that we can use/rulesetfor sets of rules.So if that was decided, how come I used the endpoint
/rulegroup? The reason is that changing the endpoint for/rulesets->/gamesystemswould require not only updating models, views, serializers, &c., but also updating a lot of the V2 data, and also updating the V1->V2 converters. In other words, it would be a monster of a PR touching many different parts of the code-base, and likely be an absolute nightmare to review.So
/rulegroupis a temporary name used to split this issue into managable chunks