Release API v 2.0.0

.github/workflows/build_and_deploy.yml

@@ -25,7 +25,7 @@ jobs:
             echo "DOCKER_IMAGE_TAG=staging" >> $GITHUB_ENV
           fi
       - name: Build and push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v7
         with:
           push: true
           tags: eepmoody/open5e-api:${{ env.DOCKER_IMAGE_TAG }}
@@ -35,7 +35,7 @@ jobs:
     needs: build
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
       - name: Install jq tool
         run: |
           sudo apt-get update

.github/workflows/clear_cache.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
 
       - name: Make script executable
         run: chmod +x scripts/clear_cloudflare_cache.sh

.github/workflows/pr_validation.yml

@@ -11,8 +11,8 @@ jobs:
   run-tests:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: '3.11'
           cache: pipenv
@@ -37,7 +37,7 @@ jobs:
       - name: Sanitize branch name
         run: echo "BRANCH_NAME=$(echo ${GITHUB_REF##*/} | tr '/' '-')" >> $GITHUB_ENV
       - name: Build Docker image
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v7
         with:
           push: false
           tags: open5e-api:${{ env.BRANCH_NAME }}

.github/workflows/rdme-openapi.yml

@@ -14,8 +14,8 @@ jobs:
   rdme-openapi:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.11"
 

.github/workflows/release.yml

@@ -10,10 +10,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
 
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v6
         with:
           python-version: '3.11'
 
@@ -24,7 +24,7 @@ jobs:
         working-directory: ${{ github.workspace }}
 
       - name: Upload release asset
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v6
         with:
           name: codebase
 

README.md

@@ -117,7 +117,7 @@ pipenv run python manage.py spectacular --color --file openapi-schema.yml` to bu
 ```
 
 # Contributing
-See [contribution guide](CONTRIBUTING.md).
+See [contribution guide](.github/CONTRIBUTING.md).
 # Tests
 
 Tests are located in the `api/tests` directory. These should be run before pushing new changes to the main repository. These tests require that the api is [running](##run) at `http://localhost:8000`.

api/filters.py

@@ -76,6 +76,10 @@ class Meta:
 
 
 class MonsterFilter(CommonFilterSet):
+    environments = django_filters.CharFilter(
+        field_name="environments_json", lookup_expr="icontains"
+    )
+
     class Meta:
         model = models.Monster
         fields = {
@@ -91,6 +95,7 @@ class Meta:
             "hit_points": ["exact", "range", "gt", "gte", "lt", "lte"],
             "armor_class": ["exact", "range", "gt", "gte", "lt", "lte"],
             "type": ["iexact", "exact", "in", "icontains"],
+            "environments_json": ["iexact", "exact", "in", "icontains"],
             "size": ["iexact", "exact", "in", "icontains"],
             "page_no": ["exact", "range", "gt", "gte", "lt", "lte"],
             "document__slug": [

api/migrations/0003_delete_manifest.py

@@ -0,0 +1,16 @@
+# Generated by Django 5.2.9 on 2026-02-13 11:54
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0002_document_v2_related_key'),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name='Manifest',
+        ),
+    ]

api/models/__init__.py

@@ -1,7 +1,6 @@
 """
 The initialization for models for open5e's api.
 """
-from .models import Manifest
 from .models import Document
 from .models import GameContent
 from .models import CharClass

api/models/models.py

@@ -7,34 +7,6 @@
 from django.template.defaultfilters import slugify
 #from api_v2 import urls as urls_v2
 
-class Manifest(models.Model):
-    """A Manifest contains a hash based on the contents of a file.
-
-    This is intended for folks who process and store content from our API.
-    When they download content, they also download the corresponding manifest.
-    Periodically, they check back in to see whether any manifests have changed.
-    If so, then they know to re-download that source.
-    """
-
-    filename = models.CharField(
-        max_length=255,
-        unique=True,
-        help_text='Input file name.')
-    type = models.CharField(
-        max_length=25,
-        help_text='Type of file (maps to a model).')
-    hash = models.CharField(max_length=255,
-                            help_text='md5 hash of the file contents.')
-    created_at = models.DateTimeField(
-        auto_now_add=True,
-        help_text='Date that this object was added to the database.')
-
-    @staticmethod
-    def plural_str() -> str:
-        """Return a string specifying the plural name of this model."""
-        return "Manifests"
-
-
 class Document(models.Model):
     slug = models.CharField(max_length=255, unique=True, default=uuid.uuid1)
     # System Reference Document

api/serializers.py

@@ -4,12 +4,6 @@
 from api import models
 from api import search_indexes
 
-
-class ManifestSerializer(serializers.ModelSerializer):
-    class Meta:
-        model = models.Manifest
-        fields = ('filename', 'type', 'hash', 'created_at')
-
 class DynamicFieldsModelSerializer(serializers.ModelSerializer):
 
     def __init__(self, *args, **kwargs):

api/tests/approved_files/TestAPIRoot.test_feats.approved.json

@@ -1,6 +1,6 @@
 {
     "count": 74,
-    "next": "http://localhost:8000/feats/?page=2",
+    "next": "http://localhost:8000/v1/feats/?page=2",
     "previous": null,
     "results": [
         {

api/tests/approved_files/TestAPIRoot.test_magicitems.approved.json

@@ -1,6 +1,6 @@
 {
     "count": 1618,
-    "next": "http://localhost:8000/magicitems/?page=2",
+    "next": "http://localhost:8000/v1/magicitems/?page=2",
     "previous": null,
     "results": [
         {

api/tests/approved_files/TestAPIRoot.test_root.approved.json

@@ -1,17 +1,16 @@
 {
-    "armor": "http://localhost:8000/v2/armor/",
-    "backgrounds": "http://localhost:8000/v2/backgrounds/",
+    "armor": "http://localhost:8000/v1/armor/",
+    "backgrounds": "http://localhost:8000/v1/backgrounds/",
     "classes": "http://localhost:8000/v1/classes/",
-    "conditions": "http://localhost:8000/v2/conditions/",
-    "documents": "http://localhost:8000/v2/documents/",
-    "feats": "http://localhost:8000/v2/feats/",
+    "conditions": "http://localhost:8000/v1/conditions/",
+    "documents": "http://localhost:8000/v1/documents/",
+    "feats": "http://localhost:8000/v1/feats/",
     "magicitems": "http://localhost:8000/v1/magicitems/",
-    "manifest": "http://localhost:8000/v1/manifest/",
     "monsters": "http://localhost:8000/v1/monsters/",
     "planes": "http://localhost:8000/v1/planes/",
     "races": "http://localhost:8000/v1/races/",
     "sections": "http://localhost:8000/v1/sections/",
     "spelllist": "http://localhost:8000/v1/spelllist/",
-    "spells": "http://localhost:8000/v2/spells/",
-    "weapons": "http://localhost:8000/v2/weapons/"
+    "spells": "http://localhost:8000/v1/spells/",
+    "weapons": "http://localhost:8000/v1/weapons/"
 }

api/tests/approved_files/TestAPIRoot.test_sections.approved.json

@@ -94,7 +94,7 @@
             "slug": "coins"
         },
         {
-            "desc": "A typical combat encounter is a clash between two sides, a flurry of weapon swings, feints, parries, footwork, and spellcasting. The game organizes the chaos of combat into a cycle of rounds and turns. A **round** represents about 6 seconds in the game world. During a round, each participant in a battle takes a **turn**. The order of turns is determined at the beginning of a combat encounter, when everyone rolls initiative. Once everyone has taken a turn, the fight continues to the next round if neither side has defeated the other.\n\n> **Combat Step by Step** > > 1. **Determine surprise.** The GM determines whether anyone involved > in the combat encounter is surprised. > 2. **Establish positions.** The GM decides where all the characters > and monsters are located. Given the adventurers' marching order or > their stated positions in the room or other location, the GM > figures out where the adversaries are\u0336 how far away and in what > direction. > 3. **Roll initiative.** Everyone involved in the combat encounter > rolls initiative, determining the order of combatants' turns. > 4. **Take turns.** Each participant in the battle takes a turn in > initiative order. > 5. **Begin the next round.** When everyone involved in the combat has > had a turn, the round ends. Repeat step 4 until the fighting > stops.\n\n**Surprise**\n\nA band of adventurers sneaks up on a bandit camp springing from the trees to attack them. A gelatinous cube glides down a dungeon passage, unnoticed by the adventurers until the cube engulfs one of them. In these situations, one side of the battle gains surprise over the other.\n\nThe GM determines who might be surprised. If neither side tries to be stealthy, they automatically notice each other. Otherwise, the GM compares the Dexterity (Stealth) checks of anyone hiding with the passive Wisdom (Perception) score of each creature on the opposing side. Any character or monster that doesn't notice a threat is surprised at the start of the encounter.\n\nIf you're surprised, you can't move or take an action on your first turn of the combat, and you can't take a reaction until that turn ends. A member of a group can be surprised even if the other members aren't.\n\n## Initiative\n\nInitiative determines the order of turns during combat. When combat starts, every participant makes a Dexterity check to determine their place in the initiative order. The GM makes one roll for an entire group of identical creatures, so each member of the group acts at the same time.\n\nThe GM ranks the combatants in order from the one with the highest Dexterity check total to the one with the lowest. This is the order (called the initiative order) in which they act during each round. The initiative order remains the same from round to round.\n\nIf a tie occurs, the GM decides the order among tied GM-controlled creatures, and the players decide the order among their tied characters. The GM can decide the order if the tie is between a monster and a player character. Optionally, the GM can have the tied characters and monsters each roll a d20 to determine the order, highest roll going first.\n\n## Your Turn\n\nOn your turn, you can **move** a distance up to your speed and **take one action**. You decide whether to move first or take your action first. Your speed---sometimes called your walking speed---is noted on your character sheet.\n\nThe most common actions you can take are described in srd:actions-in-combat. Many class features and other abilities provide additional options for your action.\n\nsrd:movement-and-position gives the rules for your move.\n\nYou can forgo moving, taking an action, or doing anything at all on your turn. If you can't decide what to do on your turn, consider taking the Dodge or Ready action, as described in srd:actions-in-combat.\n\n### Bonus Actions\n\nVarious class features, spells, and other abilities let you take an additional action on your turn called a bonus action. The Cunning Action feature, for example, allows a rogue to take a bonus action. You can take a bonus action only when a special ability, spell, or other feature of the game states that you can do something as a bonus action. You otherwise don't have a bonus action to take.\n\n> **Sage Advice**\n\n> Actions and bonus actions can't be exchanged. If you have two abilities that require bonus actions to activate you can only use one, even if you take no other actions.\n\n> Source: [Sage Advice > Compendium](http://media.wizards.com/2015/downloads/dnd/SA_Compendium_1.01.pdf)\n\nYou can take only one bonus action on your turn, so you must choose which bonus action to use when you have more than one available.\n\nYou choose when to take a bonus action during your turn, unless the bonus action's timing is specified, and anything that deprives you of your ability to take actions also prevents you from taking a bonus action.\n\n### Other Activity on Your Turn\n\nYour turn can include a variety of flourishes that require neither your action nor your move.\n\nYou can communicate however you are able, through brief utterances and gestures, as you take your turn.\n\nYou can also interact with one object or feature of the environment for free, during either your move or your action. For example, you could open a door during your move as you stride toward a foe, or you could draw your weapon as part of the same action you use to attack.\n\nIf you want to interact with a second object, you need to use your action. Some magic items and other special objects always require an action to use, as stated in their descriptions.\n\nThe GM might require you to use an action for any of these activities when it needs special care or when it presents an unusual obstacle. For instance, the GM could reasonably expect you to use an action to open a stuck door or turn a crank to lower a drawbridge.\n\n## Reactions\n\nCertain special abilities, spells, and situations allow you to take a special action called a reaction. A reaction is an instant response to a trigger of some kind, which can occur on your turn or on someone else's. The opportunity attack <srd:opportunity-attacks> is the most common type of reaction.\n\nWhen you take a reaction, you can't take another one until the start of your next turn. If the reaction interrupts another creature's turn, that creature can continue its turn right after the reaction.",
+            "desc": "A typical combat encounter is a clash between two sides, a flurry of weapon swings, feints, parries, footwork, and spellcasting. The game organizes the chaos of combat into a cycle of rounds and turns. A **round** represents about 6 seconds in the game world. During a round, each participant in a battle takes a **turn**. The order of turns is determined at the beginning of a combat encounter, when everyone rolls initiative. Once everyone has taken a turn, the fight continues to the next round if neither side has defeated the other.\n\n> **Combat Step by Step** > > 1. **Determine surprise.** The GM determines whether anyone involved > in the combat encounter is surprised. > 2. **Establish positions.** The GM decides where all the characters > and monsters are located. Given the adventurers' marching order or > their stated positions in the room or other location, the GM > figures out where the adversaries are\u0336 how far away and in what > direction. > 3. **Roll initiative.** Everyone involved in the combat encounter > rolls initiative, determining the order of combatants' turns. > 4. **Take turns.** Each participant in the battle takes a turn in > initiative order. > 5. **Begin the next round.** When everyone involved in the combat has > had a turn, the round ends. Repeat step 4 until the fighting > stops.\n\n**Surprise**\n\nA band of adventurers sneaks up on a bandit camp springing from the trees to attack them. A gelatinous cube glides down a dungeon passage, unnoticed by the adventurers until the cube engulfs one of them. In these situations, one side of the battle gains surprise over the other.\n\nThe GM determines who might be surprised. If neither side tries to be stealthy, they automatically notice each other. Otherwise, the GM compares the Dexterity (Stealth) checks of anyone hiding with the passive Wisdom (Perception) score of each creature on the opposing side. Any character or monster that doesn't notice a threat is surprised at the start of the encounter.\n\nIf you're surprised, you can't move or take an action on your first turn of the combat, and you can't take a reaction until that turn ends. A member of a group can be surprised even if the other members aren't.\n\n## Initiative\n\nInitiative determines the order of turns during combat. When combat starts, every participant makes a Dexterity check to determine their place in the initiative order. The GM makes one roll for an entire group of identical creatures, so each member of the group acts at the same time.\n\nThe GM ranks the combatants in order from the one with the highest Dexterity check total to the one with the lowest. This is the order (called the initiative order) in which they act during each round. The initiative order remains the same from round to round.\n\nIf a tie occurs, the GM decides the order among tied GM-controlled creatures, and the players decide the order among their tied characters. The GM can decide the order if the tie is between a monster and a player character. Optionally, the GM can have the tied characters and monsters each roll a d20 to determine the order, highest roll going first.\n\n## Your Turn\n\nOn your turn, you can **move** a distance up to your speed and **take one action**. You decide whether to move first or take your action first. Your speed---sometimes called your walking speed---is noted on your character sheet.\n\nThe most common actions you can take are described in srd:actions-in-combat. Many class features and other abilities provide additional options for your action.\n\nsrd:movement-and-position gives the rules for your move.\n\nYou can forgo moving, taking an action, or doing anything at all on your turn. If you can't decide what to do on your turn, consider taking the Dodge or Ready action, as described in srd:actions-in-combat.\n\n### Bonus Actions\n\nVarious class features, spells, and other abilities let you take an additional action on your turn called a bonus action. The Cunning Action feature, for example, allows a rogue to take a bonus action. You can take a bonus action only when a special ability, spell, or other feature of the game states that you can do something as a bonus action. You otherwise don't have a bonus action to take.\n\n> **Sage Advice**\n\n> Actions and bonus actions can't be exchanged. If you have two abilities that require bonus actions to activate you can only use one, even if you take no other actions.\n\n> Source: [Sage Advice > Compendium](http://media.wizards.com/2015/downloads/dnd/SA_Compendium_1.01.pdf)\n\nYou can take only one bonus action on your turn, so you must choose which bonus action to use when you have more than one available.\n\nYou choose when to take a bonus action during your turn, unless the bonus action's timing is specified, and anything that deprives you of your ability to take actions also prevents you from taking a bonus action.\n\n### Other Activity on Your Turn\n\nYour turn can include a variety of flourishes that require neither your action nor your move.\n\nYou can communicate however you are able, through brief utterances and gestures, as you take your turn.\n\nYou can also interact with one object or feature of the environment for free, during either your move or your action. For example, you could open a door during your move as you stride toward a foe, or you could draw your weapon as part of the same action you use to attack.\n\nIf you want to interact with a second object, you need to use your action. Some magic items and other special objects always require an action to use, as stated in their descriptions.\n\nThe GM might require you to use an action for any of these activities when it needs special care or when it presents an unusual obstacle. For instance, the GM could reasonably expect you to use an action to open a stuck door or turn a crank to lower a drawbridge.\n\n## Reactions\n\nCertain special abilities, spells, and situations allow you to take a special action called a reaction. A reaction is an instant response to a trigger of some kind, which can occur on your turn or on someone else's. The opportunity attack is the most common type of reaction.\n\nWhen you take a reaction, you can't take another one until the start of your next turn. If the reaction interrupts another creature's turn, that creature can continue its turn right after the reaction.",
             "document__license_url": "http://open5e.com/legal",
             "document__slug": "wotc-srd",
             "document__title": "5e Core Rules",