diff --git a/openapi-schema-v1.yml b/openapi-schema-v1.yml index aa9301de..5eb3a2c9 100644 --- a/openapi-schema-v1.yml +++ b/openapi-schema-v1.yml @@ -3,5557 +3,6 @@ info: title: Open5e version: '1' paths: - /manifest/: - get: - operationId: listManifests - description: 'API endpoint for returning a list of of manifests. - - - For each data source file, there is a corresponding manifest containing an - - MD5 hash of the data inside that file. When we update our data files, the - - corresponding manifest''s hash changes. If you host a service that - - automatically downloads data from Open5e, you can periodically check - - the manifests to determine whether your data is out of date.' - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Manifest' - description: '' - tags: - - manifest - /manifest/{id}/: - get: - operationId: retrieveManifest - description: 'API endpoint for returning a particular manifest. - - - For each data source file, there is a corresponding manifest containing an - - MD5 hash of the data inside that file. When we update our data files, the - - corresponding manifest''s hash changes. If you host a service that - - automatically downloads data from Open5e, you can periodically check - - the manifests to determine whether your data is out of date.' - parameters: - - name: id - in: path - required: true - description: A unique integer value identifying this manifest. - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Manifest' - description: '' - tags: - - manifest - /spells/: - get: - operationId: listSpells - description: API endpoint for returning a list of spells. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: spell_level - required: false - in: query - description: spell_level - schema: - type: string - - name: spell_level__range - required: false - in: query - description: spell_level__range - schema: - type: string - - name: spell_level__gt - required: false - in: query - description: spell_level__gt - schema: - type: string - - name: spell_level__gte - required: false - in: query - description: spell_level__gte - schema: - type: string - - name: spell_level__lt - required: false - in: query - description: spell_level__lt - schema: - type: string - - name: spell_level__lte - required: false - in: query - description: spell_level__lte - schema: - type: string - - name: target_range_sort - required: false - in: query - description: target_range_sort - schema: - type: string - - name: target_range_sort__range - required: false - in: query - description: target_range_sort__range - schema: - type: string - - name: target_range_sort__gt - required: false - in: query - description: target_range_sort__gt - schema: - type: string - - name: target_range_sort__gte - required: false - in: query - description: target_range_sort__gte - schema: - type: string - - name: target_range_sort__lt - required: false - in: query - description: target_range_sort__lt - schema: - type: string - - name: target_range_sort__lte - required: false - in: query - description: target_range_sort__lte - schema: - type: string - - name: school__iexact - required: false - in: query - description: school__iexact - schema: - type: string - - name: school - required: false - in: query - description: school - schema: - type: string - - name: school__in - required: false - in: query - description: school__in - schema: - type: string - - name: duration__iexact - required: false - in: query - description: duration__iexact - schema: - type: string - - name: duration - required: false - in: query - description: duration - schema: - type: string - - name: duration__in - required: false - in: query - description: duration__in - schema: - type: string - - name: requires_concentration - required: false - in: query - description: requires_concentration - schema: - type: string - - name: requires_verbal_components - required: false - in: query - description: requires_verbal_components - schema: - type: string - - name: requires_somatic_components - required: false - in: query - description: requires_somatic_components - schema: - type: string - - name: requires_material_components - required: false - in: query - description: requires_material_components - schema: - type: string - - name: casting_time__iexact - required: false - in: query - description: casting_time__iexact - schema: - type: string - - name: casting_time - required: false - in: query - description: casting_time - schema: - type: string - - name: casting_time__in - required: false - in: query - description: casting_time__in - schema: - type: string - - name: dnd_class__iexact - required: false - in: query - description: dnd_class__iexact - schema: - type: string - - name: dnd_class - required: false - in: query - description: dnd_class - schema: - type: string - - name: dnd_class__in - required: false - in: query - description: dnd_class__in - schema: - type: string - - name: dnd_class__icontains - required: false - in: query - description: dnd_class__icontains - schema: - type: string - - name: spell_lists - required: false - in: query - description: spell_lists - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: level_int - required: false - in: query - description: level_int - schema: - type: string - - name: concentration - required: false - in: query - description: concentration - schema: - type: string - - name: components - required: false - in: query - description: components - schema: - type: string - - name: spell_lists_not - required: false - in: query - description: spell_lists_not - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Spell' - description: '' - tags: - - spells - /spells/{slug}/: - get: - operationId: retrieveSpell - description: API endpoint for returning a particular spell. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: spell_level - required: false - in: query - description: spell_level - schema: - type: string - - name: spell_level__range - required: false - in: query - description: spell_level__range - schema: - type: string - - name: spell_level__gt - required: false - in: query - description: spell_level__gt - schema: - type: string - - name: spell_level__gte - required: false - in: query - description: spell_level__gte - schema: - type: string - - name: spell_level__lt - required: false - in: query - description: spell_level__lt - schema: - type: string - - name: spell_level__lte - required: false - in: query - description: spell_level__lte - schema: - type: string - - name: target_range_sort - required: false - in: query - description: target_range_sort - schema: - type: string - - name: target_range_sort__range - required: false - in: query - description: target_range_sort__range - schema: - type: string - - name: target_range_sort__gt - required: false - in: query - description: target_range_sort__gt - schema: - type: string - - name: target_range_sort__gte - required: false - in: query - description: target_range_sort__gte - schema: - type: string - - name: target_range_sort__lt - required: false - in: query - description: target_range_sort__lt - schema: - type: string - - name: target_range_sort__lte - required: false - in: query - description: target_range_sort__lte - schema: - type: string - - name: school__iexact - required: false - in: query - description: school__iexact - schema: - type: string - - name: school - required: false - in: query - description: school - schema: - type: string - - name: school__in - required: false - in: query - description: school__in - schema: - type: string - - name: duration__iexact - required: false - in: query - description: duration__iexact - schema: - type: string - - name: duration - required: false - in: query - description: duration - schema: - type: string - - name: duration__in - required: false - in: query - description: duration__in - schema: - type: string - - name: requires_concentration - required: false - in: query - description: requires_concentration - schema: - type: string - - name: requires_verbal_components - required: false - in: query - description: requires_verbal_components - schema: - type: string - - name: requires_somatic_components - required: false - in: query - description: requires_somatic_components - schema: - type: string - - name: requires_material_components - required: false - in: query - description: requires_material_components - schema: - type: string - - name: casting_time__iexact - required: false - in: query - description: casting_time__iexact - schema: - type: string - - name: casting_time - required: false - in: query - description: casting_time - schema: - type: string - - name: casting_time__in - required: false - in: query - description: casting_time__in - schema: - type: string - - name: dnd_class__iexact - required: false - in: query - description: dnd_class__iexact - schema: - type: string - - name: dnd_class - required: false - in: query - description: dnd_class - schema: - type: string - - name: dnd_class__in - required: false - in: query - description: dnd_class__in - schema: - type: string - - name: dnd_class__icontains - required: false - in: query - description: dnd_class__icontains - schema: - type: string - - name: spell_lists - required: false - in: query - description: spell_lists - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: level_int - required: false - in: query - description: level_int - schema: - type: string - - name: concentration - required: false - in: query - description: concentration - schema: - type: string - - name: components - required: false - in: query - description: components - schema: - type: string - - name: spell_lists_not - required: false - in: query - description: spell_lists_not - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Spell' - description: '' - tags: - - spells - /spelllist/: - get: - operationId: listSpellLists - description: API endpoint for returning a list of spell lists. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/SpellList' - description: '' - tags: - - spelllist - /spelllist/{slug}/: - get: - operationId: retrieveSpellList - description: API endpoint for returning a particular spell list. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SpellList' - description: '' - tags: - - spelllist - /monsters/: - get: - operationId: listMonsters - description: API endpoint for returning a list of monsters. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: cr - required: false - in: query - description: cr - schema: - type: string - - name: cr__range - required: false - in: query - description: cr__range - schema: - type: string - - name: cr__gt - required: false - in: query - description: cr__gt - schema: - type: string - - name: cr__gte - required: false - in: query - description: cr__gte - schema: - type: string - - name: cr__lt - required: false - in: query - description: cr__lt - schema: - type: string - - name: cr__lte - required: false - in: query - description: cr__lte - schema: - type: string - - name: hit_points - required: false - in: query - description: hit_points - schema: - type: string - - name: hit_points__range - required: false - in: query - description: hit_points__range - schema: - type: string - - name: hit_points__gt - required: false - in: query - description: hit_points__gt - schema: - type: string - - name: hit_points__gte - required: false - in: query - description: hit_points__gte - schema: - type: string - - name: hit_points__lt - required: false - in: query - description: hit_points__lt - schema: - type: string - - name: hit_points__lte - required: false - in: query - description: hit_points__lte - schema: - type: string - - name: armor_class - required: false - in: query - description: armor_class - schema: - type: string - - name: armor_class__range - required: false - in: query - description: armor_class__range - schema: - type: string - - name: armor_class__gt - required: false - in: query - description: armor_class__gt - schema: - type: string - - name: armor_class__gte - required: false - in: query - description: armor_class__gte - schema: - type: string - - name: armor_class__lt - required: false - in: query - description: armor_class__lt - schema: - type: string - - name: armor_class__lte - required: false - in: query - description: armor_class__lte - schema: - type: string - - name: type__iexact - required: false - in: query - description: type__iexact - schema: - type: string - - name: type - required: false - in: query - description: type - schema: - type: string - - name: type__in - required: false - in: query - description: type__in - schema: - type: string - - name: type__icontains - required: false - in: query - description: type__icontains - schema: - type: string - - name: size__iexact - required: false - in: query - description: size__iexact - schema: - type: string - - name: size - required: false - in: query - description: size - schema: - type: string - - name: size__in - required: false - in: query - description: size__in - schema: - type: string - - name: size__icontains - required: false - in: query - description: size__icontains - schema: - type: string - - name: page_no - required: false - in: query - description: page_no - schema: - type: string - - name: page_no__range - required: false - in: query - description: page_no__range - schema: - type: string - - name: page_no__gt - required: false - in: query - description: page_no__gt - schema: - type: string - - name: page_no__gte - required: false - in: query - description: page_no__gte - schema: - type: string - - name: page_no__lt - required: false - in: query - description: page_no__lt - schema: - type: string - - name: page_no__lte - required: false - in: query - description: page_no__lte - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Monster' - description: '' - tags: - - monsters - /monsters/{slug}/: - get: - operationId: retrieveMonster - description: API endpoint for returning a particular monster. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: cr - required: false - in: query - description: cr - schema: - type: string - - name: cr__range - required: false - in: query - description: cr__range - schema: - type: string - - name: cr__gt - required: false - in: query - description: cr__gt - schema: - type: string - - name: cr__gte - required: false - in: query - description: cr__gte - schema: - type: string - - name: cr__lt - required: false - in: query - description: cr__lt - schema: - type: string - - name: cr__lte - required: false - in: query - description: cr__lte - schema: - type: string - - name: hit_points - required: false - in: query - description: hit_points - schema: - type: string - - name: hit_points__range - required: false - in: query - description: hit_points__range - schema: - type: string - - name: hit_points__gt - required: false - in: query - description: hit_points__gt - schema: - type: string - - name: hit_points__gte - required: false - in: query - description: hit_points__gte - schema: - type: string - - name: hit_points__lt - required: false - in: query - description: hit_points__lt - schema: - type: string - - name: hit_points__lte - required: false - in: query - description: hit_points__lte - schema: - type: string - - name: armor_class - required: false - in: query - description: armor_class - schema: - type: string - - name: armor_class__range - required: false - in: query - description: armor_class__range - schema: - type: string - - name: armor_class__gt - required: false - in: query - description: armor_class__gt - schema: - type: string - - name: armor_class__gte - required: false - in: query - description: armor_class__gte - schema: - type: string - - name: armor_class__lt - required: false - in: query - description: armor_class__lt - schema: - type: string - - name: armor_class__lte - required: false - in: query - description: armor_class__lte - schema: - type: string - - name: type__iexact - required: false - in: query - description: type__iexact - schema: - type: string - - name: type - required: false - in: query - description: type - schema: - type: string - - name: type__in - required: false - in: query - description: type__in - schema: - type: string - - name: type__icontains - required: false - in: query - description: type__icontains - schema: - type: string - - name: size__iexact - required: false - in: query - description: size__iexact - schema: - type: string - - name: size - required: false - in: query - description: size - schema: - type: string - - name: size__in - required: false - in: query - description: size__in - schema: - type: string - - name: size__icontains - required: false - in: query - description: size__icontains - schema: - type: string - - name: page_no - required: false - in: query - description: page_no - schema: - type: string - - name: page_no__range - required: false - in: query - description: page_no__range - schema: - type: string - - name: page_no__gt - required: false - in: query - description: page_no__gt - schema: - type: string - - name: page_no__gte - required: false - in: query - description: page_no__gte - schema: - type: string - - name: page_no__lt - required: false - in: query - description: page_no__lt - schema: - type: string - - name: page_no__lte - required: false - in: query - description: page_no__lte - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Monster' - description: '' - tags: - - monsters - /documents/: - get: - operationId: listDocuments - description: API endpoint for returning a list of documents. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: title - required: false - in: query - description: title - schema: - type: string - - name: organization - required: false - in: query - description: organization - schema: - type: string - - name: license - required: false - in: query - description: license - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Document' - description: '' - tags: - - documents - /documents/{id}/: - get: - operationId: retrieveDocument - description: API endpoint for returning a particular document. - parameters: - - name: id - in: path - required: true - description: A unique integer value identifying this document. - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: title - required: false - in: query - description: title - schema: - type: string - - name: organization - required: false - in: query - description: organization - schema: - type: string - - name: license - required: false - in: query - description: license - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Document' - description: '' - tags: - - documents - /backgrounds/: - get: - operationId: listBackgrounds - description: API endpoint for returning a list of backgrounds. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: skill_proficiencies__iexact - required: false - in: query - description: skill_proficiencies__iexact - schema: - type: string - - name: skill_proficiencies - required: false - in: query - description: skill_proficiencies - schema: - type: string - - name: skill_proficiencies__icontains - required: false - in: query - description: skill_proficiencies__icontains - schema: - type: string - - name: tool_proficiencies__iexact - required: false - in: query - description: tool_proficiencies__iexact - schema: - type: string - - name: tool_proficiencies - required: false - in: query - description: tool_proficiencies - schema: - type: string - - name: tool_proficiencies__icontains - required: false - in: query - description: tool_proficiencies__icontains - schema: - type: string - - name: languages__iexact - required: false - in: query - description: languages__iexact - schema: - type: string - - name: languages - required: false - in: query - description: languages - schema: - type: string - - name: languages__icontains - required: false - in: query - description: languages__icontains - schema: - type: string - - name: feature__iexact - required: false - in: query - description: feature__iexact - schema: - type: string - - name: feature - required: false - in: query - description: feature - schema: - type: string - - name: feature__icontains - required: false - in: query - description: feature__icontains - schema: - type: string - - name: feature_desc__iexact - required: false - in: query - description: feature_desc__iexact - schema: - type: string - - name: feature_desc - required: false - in: query - description: feature_desc - schema: - type: string - - name: feature_desc__icontains - required: false - in: query - description: feature_desc__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Background' - description: '' - tags: - - backgrounds - /backgrounds/{slug}/: - get: - operationId: retrieveBackground - description: API endpoint for returning a particular background. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: skill_proficiencies__iexact - required: false - in: query - description: skill_proficiencies__iexact - schema: - type: string - - name: skill_proficiencies - required: false - in: query - description: skill_proficiencies - schema: - type: string - - name: skill_proficiencies__icontains - required: false - in: query - description: skill_proficiencies__icontains - schema: - type: string - - name: tool_proficiencies__iexact - required: false - in: query - description: tool_proficiencies__iexact - schema: - type: string - - name: tool_proficiencies - required: false - in: query - description: tool_proficiencies - schema: - type: string - - name: tool_proficiencies__icontains - required: false - in: query - description: tool_proficiencies__icontains - schema: - type: string - - name: languages__iexact - required: false - in: query - description: languages__iexact - schema: - type: string - - name: languages - required: false - in: query - description: languages - schema: - type: string - - name: languages__icontains - required: false - in: query - description: languages__icontains - schema: - type: string - - name: feature__iexact - required: false - in: query - description: feature__iexact - schema: - type: string - - name: feature - required: false - in: query - description: feature - schema: - type: string - - name: feature__icontains - required: false - in: query - description: feature__icontains - schema: - type: string - - name: feature_desc__iexact - required: false - in: query - description: feature_desc__iexact - schema: - type: string - - name: feature_desc - required: false - in: query - description: feature_desc - schema: - type: string - - name: feature_desc__icontains - required: false - in: query - description: feature_desc__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Background' - description: '' - tags: - - backgrounds - /planes/: - get: - operationId: listPlanes - description: API endpoint for returning a list of planes. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Plane' - description: '' - tags: - - planes - /planes/{slug}/: - get: - operationId: retrievePlane - description: API endpoint for returning a particular plane. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Plane' - description: '' - tags: - - planes - /sections/: - get: - operationId: listSections - description: API endpoint for returning a list of sections. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: parent__iexact - required: false - in: query - description: parent__iexact - schema: - type: string - - name: parent - required: false - in: query - description: parent - schema: - type: string - - name: parent__in - required: false - in: query - description: parent__in - schema: - type: string - - name: parent__icontains - required: false - in: query - description: parent__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Section' - description: '' - tags: - - sections - /sections/{slug}/: - get: - operationId: retrieveSection - description: API endpoint for returning a particular section. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: parent__iexact - required: false - in: query - description: parent__iexact - schema: - type: string - - name: parent - required: false - in: query - description: parent - schema: - type: string - - name: parent__in - required: false - in: query - description: parent__in - schema: - type: string - - name: parent__icontains - required: false - in: query - description: parent__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Section' - description: '' - tags: - - sections - /feats/: - get: - operationId: listFeats - description: API endpoint for returning a list of feats. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Feat' - description: '' - tags: - - feats - /feats/{slug}/: - get: - operationId: retrieveFeat - description: API endpoint for returning a particular feat. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Feat' - description: '' - tags: - - feats - /conditions/: - get: - operationId: listConditions - description: API endpoint for returning a list of conditions. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Condition' - description: '' - tags: - - conditions - /conditions/{slug}/: - get: - operationId: retrieveCondition - description: API endpoint for returning a particular condition. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Condition' - description: '' - tags: - - conditions - /races/: - get: - operationId: listRaces - description: API endpoint for returning a list of races. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: asi_desc__iexact - required: false - in: query - description: asi_desc__iexact - schema: - type: string - - name: asi_desc - required: false - in: query - description: asi_desc - schema: - type: string - - name: asi_desc__icontains - required: false - in: query - description: asi_desc__icontains - schema: - type: string - - name: age__iexact - required: false - in: query - description: age__iexact - schema: - type: string - - name: age - required: false - in: query - description: age - schema: - type: string - - name: age__icontains - required: false - in: query - description: age__icontains - schema: - type: string - - name: alignment__iexact - required: false - in: query - description: alignment__iexact - schema: - type: string - - name: alignment - required: false - in: query - description: alignment - schema: - type: string - - name: alignment__icontains - required: false - in: query - description: alignment__icontains - schema: - type: string - - name: size__iexact - required: false - in: query - description: size__iexact - schema: - type: string - - name: size - required: false - in: query - description: size - schema: - type: string - - name: size__icontains - required: false - in: query - description: size__icontains - schema: - type: string - - name: speed_desc__iexact - required: false - in: query - description: speed_desc__iexact - schema: - type: string - - name: speed_desc - required: false - in: query - description: speed_desc - schema: - type: string - - name: speed_desc__icontains - required: false - in: query - description: speed_desc__icontains - schema: - type: string - - name: languages__iexact - required: false - in: query - description: languages__iexact - schema: - type: string - - name: languages - required: false - in: query - description: languages - schema: - type: string - - name: languages__icontains - required: false - in: query - description: languages__icontains - schema: - type: string - - name: vision__iexact - required: false - in: query - description: vision__iexact - schema: - type: string - - name: vision - required: false - in: query - description: vision - schema: - type: string - - name: vision__icontains - required: false - in: query - description: vision__icontains - schema: - type: string - - name: traits__iexact - required: false - in: query - description: traits__iexact - schema: - type: string - - name: traits - required: false - in: query - description: traits - schema: - type: string - - name: traits__icontains - required: false - in: query - description: traits__icontains - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Race' - description: '' - tags: - - races - /races/{slug}/: - get: - operationId: retrieveRace - description: API endpoint for returning a particular race. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: asi_desc__iexact - required: false - in: query - description: asi_desc__iexact - schema: - type: string - - name: asi_desc - required: false - in: query - description: asi_desc - schema: - type: string - - name: asi_desc__icontains - required: false - in: query - description: asi_desc__icontains - schema: - type: string - - name: age__iexact - required: false - in: query - description: age__iexact - schema: - type: string - - name: age - required: false - in: query - description: age - schema: - type: string - - name: age__icontains - required: false - in: query - description: age__icontains - schema: - type: string - - name: alignment__iexact - required: false - in: query - description: alignment__iexact - schema: - type: string - - name: alignment - required: false - in: query - description: alignment - schema: - type: string - - name: alignment__icontains - required: false - in: query - description: alignment__icontains - schema: - type: string - - name: size__iexact - required: false - in: query - description: size__iexact - schema: - type: string - - name: size - required: false - in: query - description: size - schema: - type: string - - name: size__icontains - required: false - in: query - description: size__icontains - schema: - type: string - - name: speed_desc__iexact - required: false - in: query - description: speed_desc__iexact - schema: - type: string - - name: speed_desc - required: false - in: query - description: speed_desc - schema: - type: string - - name: speed_desc__icontains - required: false - in: query - description: speed_desc__icontains - schema: - type: string - - name: languages__iexact - required: false - in: query - description: languages__iexact - schema: - type: string - - name: languages - required: false - in: query - description: languages - schema: - type: string - - name: languages__icontains - required: false - in: query - description: languages__icontains - schema: - type: string - - name: vision__iexact - required: false - in: query - description: vision__iexact - schema: - type: string - - name: vision - required: false - in: query - description: vision - schema: - type: string - - name: vision__icontains - required: false - in: query - description: vision__icontains - schema: - type: string - - name: traits__iexact - required: false - in: query - description: traits__iexact - schema: - type: string - - name: traits - required: false - in: query - description: traits - schema: - type: string - - name: traits__icontains - required: false - in: query - description: traits__icontains - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Race' - description: '' - tags: - - races - /classes/: - get: - operationId: listCharClasses - description: API endpoint for returning a list of classes and archetypes. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: hit_dice__iexact - required: false - in: query - description: hit_dice__iexact - schema: - type: string - - name: hit_dice - required: false - in: query - description: hit_dice - schema: - type: string - - name: hit_dice__in - required: false - in: query - description: hit_dice__in - schema: - type: string - - name: hp_at_1st_level__iexact - required: false - in: query - description: hp_at_1st_level__iexact - schema: - type: string - - name: hp_at_1st_level - required: false - in: query - description: hp_at_1st_level - schema: - type: string - - name: hp_at_1st_level__icontains - required: false - in: query - description: hp_at_1st_level__icontains - schema: - type: string - - name: hp_at_higher_levels__iexact - required: false - in: query - description: hp_at_higher_levels__iexact - schema: - type: string - - name: hp_at_higher_levels - required: false - in: query - description: hp_at_higher_levels - schema: - type: string - - name: hp_at_higher_levels__icontains - required: false - in: query - description: hp_at_higher_levels__icontains - schema: - type: string - - name: prof_armor__iexact - required: false - in: query - description: prof_armor__iexact - schema: - type: string - - name: prof_armor - required: false - in: query - description: prof_armor - schema: - type: string - - name: prof_armor__icontains - required: false - in: query - description: prof_armor__icontains - schema: - type: string - - name: prof_weapons__iexact - required: false - in: query - description: prof_weapons__iexact - schema: - type: string - - name: prof_weapons - required: false - in: query - description: prof_weapons - schema: - type: string - - name: prof_weapons__icontains - required: false - in: query - description: prof_weapons__icontains - schema: - type: string - - name: prof_tools__iexact - required: false - in: query - description: prof_tools__iexact - schema: - type: string - - name: prof_tools - required: false - in: query - description: prof_tools - schema: - type: string - - name: prof_tools__icontains - required: false - in: query - description: prof_tools__icontains - schema: - type: string - - name: prof_skills__iexact - required: false - in: query - description: prof_skills__iexact - schema: - type: string - - name: prof_skills - required: false - in: query - description: prof_skills - schema: - type: string - - name: prof_skills__icontains - required: false - in: query - description: prof_skills__icontains - schema: - type: string - - name: equipment__iexact - required: false - in: query - description: equipment__iexact - schema: - type: string - - name: equipment - required: false - in: query - description: equipment - schema: - type: string - - name: equipment__icontains - required: false - in: query - description: equipment__icontains - schema: - type: string - - name: spellcasting_ability__iexact - required: false - in: query - description: spellcasting_ability__iexact - schema: - type: string - - name: spellcasting_ability - required: false - in: query - description: spellcasting_ability - schema: - type: string - - name: spellcasting_ability__icontains - required: false - in: query - description: spellcasting_ability__icontains - schema: - type: string - - name: subtypes_name__iexact - required: false - in: query - description: subtypes_name__iexact - schema: - type: string - - name: subtypes_name - required: false - in: query - description: subtypes_name - schema: - type: string - - name: subtypes_name__icontains - required: false - in: query - description: subtypes_name__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/CharClass' - description: '' - tags: - - classes - /classes/{slug}/: - get: - operationId: retrieveCharClass - description: API endpoint for returning a particular class or archetype. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: hit_dice__iexact - required: false - in: query - description: hit_dice__iexact - schema: - type: string - - name: hit_dice - required: false - in: query - description: hit_dice - schema: - type: string - - name: hit_dice__in - required: false - in: query - description: hit_dice__in - schema: - type: string - - name: hp_at_1st_level__iexact - required: false - in: query - description: hp_at_1st_level__iexact - schema: - type: string - - name: hp_at_1st_level - required: false - in: query - description: hp_at_1st_level - schema: - type: string - - name: hp_at_1st_level__icontains - required: false - in: query - description: hp_at_1st_level__icontains - schema: - type: string - - name: hp_at_higher_levels__iexact - required: false - in: query - description: hp_at_higher_levels__iexact - schema: - type: string - - name: hp_at_higher_levels - required: false - in: query - description: hp_at_higher_levels - schema: - type: string - - name: hp_at_higher_levels__icontains - required: false - in: query - description: hp_at_higher_levels__icontains - schema: - type: string - - name: prof_armor__iexact - required: false - in: query - description: prof_armor__iexact - schema: - type: string - - name: prof_armor - required: false - in: query - description: prof_armor - schema: - type: string - - name: prof_armor__icontains - required: false - in: query - description: prof_armor__icontains - schema: - type: string - - name: prof_weapons__iexact - required: false - in: query - description: prof_weapons__iexact - schema: - type: string - - name: prof_weapons - required: false - in: query - description: prof_weapons - schema: - type: string - - name: prof_weapons__icontains - required: false - in: query - description: prof_weapons__icontains - schema: - type: string - - name: prof_tools__iexact - required: false - in: query - description: prof_tools__iexact - schema: - type: string - - name: prof_tools - required: false - in: query - description: prof_tools - schema: - type: string - - name: prof_tools__icontains - required: false - in: query - description: prof_tools__icontains - schema: - type: string - - name: prof_skills__iexact - required: false - in: query - description: prof_skills__iexact - schema: - type: string - - name: prof_skills - required: false - in: query - description: prof_skills - schema: - type: string - - name: prof_skills__icontains - required: false - in: query - description: prof_skills__icontains - schema: - type: string - - name: equipment__iexact - required: false - in: query - description: equipment__iexact - schema: - type: string - - name: equipment - required: false - in: query - description: equipment - schema: - type: string - - name: equipment__icontains - required: false - in: query - description: equipment__icontains - schema: - type: string - - name: spellcasting_ability__iexact - required: false - in: query - description: spellcasting_ability__iexact - schema: - type: string - - name: spellcasting_ability - required: false - in: query - description: spellcasting_ability - schema: - type: string - - name: spellcasting_ability__icontains - required: false - in: query - description: spellcasting_ability__icontains - schema: - type: string - - name: subtypes_name__iexact - required: false - in: query - description: subtypes_name__iexact - schema: - type: string - - name: subtypes_name - required: false - in: query - description: subtypes_name - schema: - type: string - - name: subtypes_name__icontains - required: false - in: query - description: subtypes_name__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/CharClass' - description: '' - tags: - - classes - /magicitems/: - get: - operationId: listMagicItems - description: API endpoint for returning a list of magic items. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: type__iexact - required: false - in: query - description: type__iexact - schema: - type: string - - name: type - required: false - in: query - description: type - schema: - type: string - - name: type__icontains - required: false - in: query - description: type__icontains - schema: - type: string - - name: rarity__iexact - required: false - in: query - description: rarity__iexact - schema: - type: string - - name: rarity - required: false - in: query - description: rarity - schema: - type: string - - name: rarity__icontains - required: false - in: query - description: rarity__icontains - schema: - type: string - - name: requires_attunement__iexact - required: false - in: query - description: requires_attunement__iexact - schema: - type: string - - name: requires_attunement - required: false - in: query - description: requires_attunement - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/MagicItem' - description: '' - tags: - - magicitems - /magicitems/{slug}/: - get: - operationId: retrieveMagicItem - description: API endpoint for returning a particular magic item. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: type__iexact - required: false - in: query - description: type__iexact - schema: - type: string - - name: type - required: false - in: query - description: type - schema: - type: string - - name: type__icontains - required: false - in: query - description: type__icontains - schema: - type: string - - name: rarity__iexact - required: false - in: query - description: rarity__iexact - schema: - type: string - - name: rarity - required: false - in: query - description: rarity - schema: - type: string - - name: rarity__icontains - required: false - in: query - description: rarity__icontains - schema: - type: string - - name: requires_attunement__iexact - required: false - in: query - description: requires_attunement__iexact - schema: - type: string - - name: requires_attunement - required: false - in: query - description: requires_attunement - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MagicItem' - description: '' - tags: - - magicitems - /weapons/: - get: - operationId: listWeapons - description: API endpoint for returning a list of weapons. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: cost__iexact - required: false - in: query - description: cost__iexact - schema: - type: string - - name: cost - required: false - in: query - description: cost - schema: - type: string - - name: cost__icontains - required: false - in: query - description: cost__icontains - schema: - type: string - - name: damage_dice__iexact - required: false - in: query - description: damage_dice__iexact - schema: - type: string - - name: damage_dice - required: false - in: query - description: damage_dice - schema: - type: string - - name: damage_dice__icontains - required: false - in: query - description: damage_dice__icontains - schema: - type: string - - name: damage_type__iexact - required: false - in: query - description: damage_type__iexact - schema: - type: string - - name: damage_type - required: false - in: query - description: damage_type - schema: - type: string - - name: damage_type__icontains - required: false - in: query - description: damage_type__icontains - schema: - type: string - - name: weight__iexact - required: false - in: query - description: weight__iexact - schema: - type: string - - name: weight - required: false - in: query - description: weight - schema: - type: string - - name: weight__icontains - required: false - in: query - description: weight__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Weapon' - description: '' - tags: - - weapons - /weapons/{slug}/: - get: - operationId: retrieveWeapon - description: API endpoint for returning a particular weapon. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: cost__iexact - required: false - in: query - description: cost__iexact - schema: - type: string - - name: cost - required: false - in: query - description: cost - schema: - type: string - - name: cost__icontains - required: false - in: query - description: cost__icontains - schema: - type: string - - name: damage_dice__iexact - required: false - in: query - description: damage_dice__iexact - schema: - type: string - - name: damage_dice - required: false - in: query - description: damage_dice - schema: - type: string - - name: damage_dice__icontains - required: false - in: query - description: damage_dice__icontains - schema: - type: string - - name: damage_type__iexact - required: false - in: query - description: damage_type__iexact - schema: - type: string - - name: damage_type - required: false - in: query - description: damage_type - schema: - type: string - - name: damage_type__icontains - required: false - in: query - description: damage_type__icontains - schema: - type: string - - name: weight__iexact - required: false - in: query - description: weight__iexact - schema: - type: string - - name: weight - required: false - in: query - description: weight - schema: - type: string - - name: weight__icontains - required: false - in: query - description: weight__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Weapon' - description: '' - tags: - - weapons - /armor/: - get: - operationId: listArmors - description: API endpoint for returning a list of armor. - parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: cost__iexact - required: false - in: query - description: cost__iexact - schema: - type: string - - name: cost - required: false - in: query - description: cost - schema: - type: string - - name: cost__icontains - required: false - in: query - description: cost__icontains - schema: - type: string - - name: weight__iexact - required: false - in: query - description: weight__iexact - schema: - type: string - - name: weight - required: false - in: query - description: weight - schema: - type: string - - name: weight__icontains - required: false - in: query - description: weight__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - required: - - count - - results - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Armor' - description: '' - tags: - - armor - /armor/{slug}/: - get: - operationId: retrieveArmor - description: API endpoint for returning a particular armor. - parameters: - - name: slug - in: path - required: true - description: Short name for the game content item. - schema: - type: string - - name: slug__in - required: false - in: query - description: slug__in - schema: - type: string - - name: slug__iexact - required: false - in: query - description: slug__iexact - schema: - type: string - - name: slug - required: false - in: query - description: slug - schema: - type: string - - name: name__iexact - required: false - in: query - description: name__iexact - schema: - type: string - - name: name - required: false - in: query - description: name - schema: - type: string - - name: name__icontains - required: false - in: query - description: name__icontains - schema: - type: string - - name: desc__iexact - required: false - in: query - description: desc__iexact - schema: - type: string - - name: desc - required: false - in: query - description: desc - schema: - type: string - - name: desc__in - required: false - in: query - description: desc__in - schema: - type: string - - name: desc__icontains - required: false - in: query - description: desc__icontains - schema: - type: string - - name: cost__iexact - required: false - in: query - description: cost__iexact - schema: - type: string - - name: cost - required: false - in: query - description: cost - schema: - type: string - - name: cost__icontains - required: false - in: query - description: cost__icontains - schema: - type: string - - name: weight__iexact - required: false - in: query - description: weight__iexact - schema: - type: string - - name: weight - required: false - in: query - description: weight - schema: - type: string - - name: weight__icontains - required: false - in: query - description: weight__icontains - schema: - type: string - - name: document__slug__iexact - required: false - in: query - description: document__slug__iexact - schema: - type: string - - name: document__slug - required: false - in: query - description: document__slug - schema: - type: string - - name: document__slug__in - required: false - in: query - description: document__slug__in - schema: - type: string - - name: document__slug__not_in - required: false - in: query - description: document__slug__not_in - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: search - required: false - in: query - description: A search term. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Armor' - description: '' - tags: - - armor /version/: get: operationId: listget_versions