Pulling main up to speed.

.github/workflows/rdme-openapi.yml

@@ -20,4 +20,5 @@ jobs:
       - name: Run `openapi` command 🚀
         uses: readmeio/rdme@v8
         with:
-          rdme: openapi openapi-schema.yml --key=${{ secrets.README_API_KEY }} --id=641f6d9e0ffbcd06c0e7343c
+          rdme: openapi openapi-schema-v1.yml --key=${{ secrets.README_API_KEY }} --id=641f6d9e0ffbcd06c0e7343c
+          rdme: openapi openapi-schema-v2.yml --key=${{ secrets.README_API_KEY }} --id=641f6d9e0ffbcd06c0e7343c

README.md

@@ -101,12 +101,14 @@ Run the server locally. This server is only for development and shall __not__ be
 pipenv run python manage.py runserver
 ```
 
-If you need to run the server on another port, add the port number as an argument.
+### Self-hosting
+If you would like to host the API yourself locally, we suggest using gunicorn as your wsgi server. Below is an equivalent command to what we use in production, which makes the server available at `http://localhost:8888`.
 
 ```bash
-pipenv run python manage.py runserver $PORT
+gunicorn -b :8888 server.wsgi:application
 ```
 
+You can use our Dockerfile as inspiration, but it likely will not work without significant edits to your operating environment. We have customized our production environment to use it.
 
 ## Building the OAS file
 

api/schema_generator.py

@@ -1,4 +1,4 @@
-from rest_framework.schemas.openapi import SchemaGenerator
+'''from rest_framework.schemas.openapi import SchemaGenerator
 from rest_framework.schemas.openapi import AutoSchema
 
 # Adds additional metadata onto an OAS operation. Attach this to your view and provide the necessary constructor args.
@@ -21,6 +21,7 @@ def get_operation(self, path, method):
         oldOperation = super().get_operation(path, method)
 
         # I can't find a version of DRF that support summaries
+        if path.startswith('/v1/'): return oldOperation
         oldOperation['summary'] = self.extra_info['summary'][path]
 
         # Future versions of DRF support tags
@@ -61,3 +62,4 @@ def get_schema(self, *args, **kwargs):
         # This isn't a real endpoint, so we remove it from the schema
         schema['paths'].pop('/search/{id}/')
         return schema
+'''

api/serializers.py

@@ -18,14 +18,15 @@ def __init__(self, *args, **kwargs):
 
         # The request doesn't exist when generating an OAS file, so we have to check that first
         if 'request' in self.context:
-            fields = self.context['request'].query_params.get('fields')
-            if fields:
-                fields = fields.split(',')
-                # Drop any fields that are not specified in the `fields` argument.
-                allowed = set(fields)
-                existing = set(self.fields.keys())
-                for field_name in existing - allowed:
-                    self.fields.pop(field_name)
+            if self.context['request'] is not None:
+                fields = self.context['request'].query_params.get('fields')
+                if fields:
+                    fields = fields.split(',')
+                    # Drop any fields that are not specified in the `fields` argument.
+                    allowed = set(fields)
+                    existing = set(self.fields.keys())
+                    for field_name in existing - allowed:
+                        self.fields.pop(field_name)
 
 class DynamicFieldsHyperlinkedModelSerializer(
     DynamicFieldsModelSerializer, serializers.HyperlinkedModelSerializer

api/urls.py

@@ -0,0 +1,28 @@
+from rest_framework import routers
+from django.conf.urls import include
+from django.urls import path
+
+from api import views
+
+router = routers.DefaultRouter()
+router.register(r'manifest', views.ManifestViewSet)
+router.register(r'spells', views.SpellViewSet)
+router.register(r'spelllist',views.SpellListViewSet)
+router.register(r'monsters', views.MonsterViewSet)
+router.register(r'documents', views.DocumentViewSet)
+router.register(r'backgrounds', views.BackgroundViewSet)
+router.register(r'planes', views.PlaneViewSet)
+router.register(r'sections', views.SectionViewSet)
+router.register(r'feats', views.FeatViewSet)
+router.register(r'conditions', views.ConditionViewSet)
+router.register(r'races',views.RaceViewSet)
+router.register(r'classes',views.CharClassViewSet)
+router.register(r'magicitems',views.MagicItemViewSet)
+router.register(r'weapons',views.WeaponViewSet)
+router.register(r'armor',views.ArmorViewSet)
+
+urlpatterns = [
+    path('', include(router.urls)), #Consider removing this after a while.
+    path('version/', views.get_version, name="version"),
+    path('v1/', include(router.urls))
+    ]

api/views.py

@@ -7,7 +7,7 @@
 from api import models
 from api import serializers
 from api import filters
-from api.schema_generator import CustomSchema
+#from api.schema_generator import CustomSchema
 
 
 class ManifestViewSet(viewsets.ReadOnlyModelViewSet):
@@ -28,13 +28,6 @@ class ManifestViewSet(viewsets.ReadOnlyModelViewSet):
     automatically downloads data from Open5e, you can periodically check
     the manifests to determine whether your data is out of date.
     """
-    schema = CustomSchema(
-        summary={
-            '/manifest/': 'List Manifests',
-            '/manifest/{id}/': 'Retrieve Manifest',
-        },
-        tags=['Manifests'],
-    )
     queryset = models.Manifest.objects.all().order_by("pk")
     serializer_class = serializers.ManifestSerializer
 
@@ -102,18 +95,6 @@ class DocumentViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of documents.
     retrieve: API endpoint for returning a particular document.
     """
-    schema = CustomSchema(
-        summary={
-			'/documents/': 'List Documents',
-			'/documents/{id}/': 'Retrieve Document',
-		},
-        tags=['Documents'],
-        query={
-			'slug': 'A short, human readable string uniquely identifying this document',
-			'title': 'A short descriptive title of this document',
-			'organization': 'The organization that published the document',
-			'license': 'The license under which the document is published',
-		})
     queryset = models.Document.objects.all().order_by("pk")
     serializer_class = serializers.DocumentSerializer
     search_fields = ['title', 'desc']
@@ -130,13 +111,6 @@ class SpellViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of spells.
     retrieve: API endpoint for returning a particular spell.
     """
-    schema = CustomSchema(
-        summary={
-            '/spells/': 'List Spells',
-            '/spells/{slug}/': 'Retrieve Spell',
-        },
-        tags=['Spells']
-    )
     queryset = models.Spell.objects.all().order_by("pk")
     filterset_class=filters.SpellFilter
     serializer_class = serializers.SpellSerializer
@@ -163,13 +137,6 @@ class SpellListViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of spell lists.
     retrieve: API endpoint for returning a particular spell list.
     """
-    schema = CustomSchema(
-        summary={
-            '/spelllist/': 'List Spell Lists',
-            '/spelllist/{slug}/': 'Retrieve Spell List',
-        },
-        tags=['SpellList']
-    )
     queryset = models.SpellList.objects.all().order_by("pk")
     serializer_class = serializers.SpellListSerializer
     filterset_class = filters.SpellListFilter
@@ -181,13 +148,6 @@ class MonsterViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of monsters.
     retrieve: API endpoint for returning a particular monster.
     """
-    schema = CustomSchema(
-        summary={
-            '/monsters/': 'List Monsters',
-            '/monsters/{slug}/': 'Retrieve Monster',
-        },
-        tags=['Monsters']
-    )
     queryset = models.Monster.objects.all().order_by("pk")
     filterset_class = filters.MonsterFilter
 
@@ -199,13 +159,6 @@ class BackgroundViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of backgrounds.
     retrieve: API endpoint for returning a particular background.
     """
-    schema = CustomSchema(
-        summary={
-            '/backgrounds/': 'List Backgrounds',
-            '/backgrounds/{slug}/': 'Retrieve Background',
-        },
-        tags=['Backgrounds']
-    )
     queryset = models.Background.objects.all().order_by("pk")
     serializer_class = serializers.BackgroundSerializer
     ordering_fields = '__all__'
@@ -219,13 +172,6 @@ class PlaneViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of planes.
     retrieve: API endpoint for returning a particular plane.
     """
-    schema = CustomSchema(
-        summary={
-            '/planes/': 'List Planes',
-            '/planes/{slug}/': 'Retrieve Plane',
-        },
-        tags=['Planes']
-    )
     queryset = models.Plane.objects.all().order_by("pk")
     serializer_class = serializers.PlaneSerializer
     filterset_class = filters.PlaneFilter
@@ -237,13 +183,6 @@ class SectionViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of sections.
     retrieve: API endpoint for returning a particular section.
     """
-    schema = CustomSchema(
-        summary={
-            '/sections/': 'List Sections',
-            '/sections/{slug}/': 'Retrieve Section',
-        },
-        tags=['Sections']
-    )
     queryset = models.Section.objects.all().order_by("pk")
     serializer_class = serializers.SectionSerializer
     ordering_fields = '__all__'
@@ -257,13 +196,6 @@ class FeatViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of feats.
     retrieve: API endpoint for returning a particular feat.
     """
-    schema = CustomSchema(
-        summary={
-            '/feats/': 'List Feats',
-            '/feats/{slug}/': 'Retrieve Feat',
-        },
-        tags=['Feats']
-    )
     queryset = models.Feat.objects.all().order_by("pk")
     serializer_class = serializers.FeatSerializer
     filterset_class = filters.FeatFilter
@@ -275,13 +207,6 @@ class ConditionViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of conditions.
     retrieve: API endpoint for returning a particular condition.
     """
-    schema = CustomSchema(
-        summary={
-            '/conditions/': 'List Conditions',
-            '/conditions/{slug}/': 'Retrieve Condition',
-        },
-        tags=['Conditions']
-    )
     queryset = models.Condition.objects.all().order_by("pk")
     serializer_class = serializers.ConditionSerializer
     search_fields = ['name', 'desc']
@@ -293,13 +218,6 @@ class RaceViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of races.
     retrieve: API endpoint for returning a particular race.
     """
-    schema = CustomSchema(
-        summary={
-            '/races/': 'List Races',
-            '/races/{slug}/': 'Retrieve Race',
-        },
-        tags=['Races']
-    )
     queryset = models.Race.objects.all().order_by("pk")
     serializer_class = serializers.RaceSerializer
     filterset_class = filters.RaceFilter
@@ -312,13 +230,6 @@ class SubraceViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint that allows viewing of Subraces.
     retrieve: API endpoint for returning a particular subrace.
     """
-    schema = CustomSchema(
-        summary={
-            '/subraces/': 'List Subraces',
-            '/subraces/{slug}/': 'Retrieve Subrace',
-        },
-        tags=['Subraces']
-    )
     queryset = models.Subrace.objects.all().order_by("pk")
     serializer_class = serializers.SubraceSerializer
     search_fields = ['name', 'desc']
@@ -333,13 +244,6 @@ class CharClassViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of classes and archetypes.
     retrieve: API endpoint for returning a particular class or archetype.
     """
-    schema = CustomSchema(
-        summary={
-            '/classes/': 'List Classes',
-            '/classes/{slug}/': 'Retrieve Class',
-        },
-        tags=['Classes']
-    )
     queryset = models.CharClass.objects.all().order_by("pk")
     serializer_class = serializers.CharClassSerializer
     filterset_class = filters.CharClassFilter
@@ -352,13 +256,6 @@ class ArchetypeViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint that allows viewing of Archetypes.
     retrieve: API endpoint for returning a particular archetype.
     """
-    schema = CustomSchema(
-        summary={
-            '/archetypes/': 'List Archetypes',
-            '/archetypes/{slug}/': 'Retrieve Archetype',
-        },
-        tags=['Archetypes']
-    )
     queryset = models.Archetype.objects.all().order_by("pk")
     serializer_class = serializers.ArchetypeSerializer
     search_fields = ['name', 'desc']
@@ -373,13 +270,6 @@ class MagicItemViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of magic items.
     retrieve: API endpoint for returning a particular magic item.
     """
-    schema = CustomSchema(
-        summary={
-            '/magicitems/': 'List Magic Items',
-            '/magicitems/{slug}/': 'Retrieve Magic Item',
-        },
-        tags=['Magic Items']
-    )
     queryset = models.MagicItem.objects.all().order_by("pk")
     serializer_class = serializers.MagicItemSerializer
     filterset_class = filters.MagicItemFilter
@@ -391,13 +281,6 @@ class WeaponViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of weapons.
     retrieve: API endpoint for returning a particular weapon.
     """
-    schema = CustomSchema(
-        summary={
-            '/weapons/': 'List Weapons',
-            '/weapons/{slug}/': 'Retrieve Weapon',
-        },
-        tags=['Weapons']
-    )
     queryset = models.Weapon.objects.all().order_by("pk")
     serializer_class = serializers.WeaponSerializer
     filterset_class = filters.WeaponFilter
@@ -409,13 +292,6 @@ class ArmorViewSet(viewsets.ReadOnlyModelViewSet):
     list: API endpoint for returning a list of armor.
     retrieve: API endpoint for returning a particular armor.
     """
-    schema = CustomSchema(
-        summary={
-            '/armor/': 'List Armor',
-            '/armor/{slug}/': 'Retrieve Armor',
-        },
-        tags=['Armor']
-    )
     queryset = models.Armor.objects.all().order_by("pk")
     serializer_class = serializers.ArmorSerializer
     filterset_class = filters.ArmorFilter

api_v2/models/armor.py

@@ -39,6 +39,16 @@ class Armor(HasName, FromDocument):
         null=True,
         help_text='Integer representing the dexterity modifier cap.')
 
+    @property
+    def category(self):
+        category = 'heavy'
+        if self.ac_add_dexmod:
+            category= 'light'
+        if self.ac_cap_dexmod:
+            category= 'medium'
+        return category
+
+
     @property
     def ac_display(self):
         """Display text for armor class."""