openapi-schema.yml

openapi: 3.0.2
info:
  title: Open5e
  version: ''
  description: The Open5e API includes all monsters and spells from the SRD and other
    OGL sources as well as a search API, so you can access any part of the SRD from
    your app or website.
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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        filename:
                          type: string
                          maxLength: 255
                        type:
                          type: string
                          maxLength: 25
                        hash:
                          type: string
                          maxLength: 255
                        created_at:
                          type: string
                          format: date-time
                          readOnly: true
                      required:
                      - filename
                      - type
                      - hash
          description: ''
      summary: List Manifests
      tags: &id001
      - Manifests
  /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:
                properties:
                  filename:
                    type: string
                    maxLength: 255
                  type:
                    type: string
                    maxLength: 25
                  hash:
                    type: string
                    maxLength: 255
                  created_at:
                    type: string
                    format: date-time
                    readOnly: true
                required:
                - filename
                - type
                - hash
          description: ''
      summary: Retrieve Manifest
      tags: *id001
  /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: level__iexact
        required: false
        in: query
        description: level__iexact
        schema:
          type: string
      - name: level
        required: false
        in: query
        description: level
        schema:
          type: string
      - name: level__in
        required: false
        in: query
        description: level__in
        schema:
          type: string
      - name: level_int__iexact
        required: false
        in: query
        description: level_int__iexact
        schema:
          type: string
      - name: level_int
        required: false
        in: query
        description: level_int
        schema:
          type: string
      - name: level_int__range
        required: false
        in: query
        description: level_int__range
        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: components__iexact
        required: false
        in: query
        description: components__iexact
        schema:
          type: string
      - name: components
        required: false
        in: query
        description: components
        schema:
          type: string
      - name: components__in
        required: false
        in: query
        description: components__in
        schema:
          type: string
      - name: concentration__iexact
        required: false
        in: query
        description: concentration__iexact
        schema:
          type: string
      - name: concentration
        required: false
        in: query
        description: concentration
        schema:
          type: string
      - name: concentration__in
        required: false
        in: query
        description: concentration__in
        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: 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: 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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        slug:
                          type: string
                          maxLength: 255
                        name:
                          type: string
                        desc:
                          type: string
                        higher_level:
                          type: string
                        page:
                          type: string
                        range:
                          type: string
                        components:
                          type: string
                        material:
                          type: string
                        ritual:
                          type: string
                        duration:
                          type: string
                        concentration:
                          type: string
                        casting_time:
                          type: string
                        level:
                          type: string
                        level_int:
                          type: integer
                          nullable: true
                        school:
                          type: string
                        dnd_class:
                          type: string
                        archetype:
                          type: string
                        circles:
                          type: string
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                        document__license_url:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - desc
                      - higher_level
                      - page
                      - range
                      - components
                      - material
                      - ritual
                      - duration
                      - concentration
                      - casting_time
                      - level
                      - school
                      - dnd_class
                      - archetype
                      - circles
          description: ''
      summary: List Spells
      tags: &id002
      - Spells
  /spells/{slug}/:
    get:
      operationId: retrieveSpell
      description: API endpoint for returning a particular spell.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this spell.
        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: level__iexact
        required: false
        in: query
        description: level__iexact
        schema:
          type: string
      - name: level
        required: false
        in: query
        description: level
        schema:
          type: string
      - name: level__in
        required: false
        in: query
        description: level__in
        schema:
          type: string
      - name: level_int__iexact
        required: false
        in: query
        description: level_int__iexact
        schema:
          type: string
      - name: level_int
        required: false
        in: query
        description: level_int
        schema:
          type: string
      - name: level_int__range
        required: false
        in: query
        description: level_int__range
        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: components__iexact
        required: false
        in: query
        description: components__iexact
        schema:
          type: string
      - name: components
        required: false
        in: query
        description: components
        schema:
          type: string
      - name: components__in
        required: false
        in: query
        description: components__in
        schema:
          type: string
      - name: concentration__iexact
        required: false
        in: query
        description: concentration__iexact
        schema:
          type: string
      - name: concentration
        required: false
        in: query
        description: concentration
        schema:
          type: string
      - name: concentration__in
        required: false
        in: query
        description: concentration__in
        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: 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: 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:
                properties:
                  slug:
                    type: string
                    maxLength: 255
                  name:
                    type: string
                  desc:
                    type: string
                  higher_level:
                    type: string
                  page:
                    type: string
                  range:
                    type: string
                  components:
                    type: string
                  material:
                    type: string
                  ritual:
                    type: string
                  duration:
                    type: string
                  concentration:
                    type: string
                  casting_time:
                    type: string
                  level:
                    type: string
                  level_int:
                    type: integer
                    nullable: true
                  school:
                    type: string
                  dnd_class:
                    type: string
                  archetype:
                    type: string
                  circles:
                    type: string
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                  document__license_url:
                    type: string
                    readOnly: true
                required:
                - name
                - desc
                - higher_level
                - page
                - range
                - components
                - material
                - ritual
                - duration
                - concentration
                - casting_time
                - level
                - school
                - dnd_class
                - archetype
                - circles
          description: ''
      summary: Retrieve Spell
      tags: *id002
  /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: challenge_rating
        required: false
        in: query
        description: challenge_rating
        schema:
          type: string
      - name: armor_class
        required: false
        in: query
        description: armor_class
        schema:
          type: string
      - name: type
        required: false
        in: query
        description: type
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: page_no
        required: false
        in: query
        description: page_no
        schema:
          type: string
      - name: document
        required: false
        in: query
        description: document
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        slug:
                          type: string
                          maxLength: 255
                        name:
                          type: string
                        size:
                          type: string
                        type:
                          type: string
                        subtype:
                          type: string
                        group:
                          type: string
                          nullable: true
                        alignment:
                          type: string
                        armor_class:
                          type: integer
                        armor_desc:
                          type: string
                          nullable: true
                        hit_points:
                          type: integer
                          nullable: true
                        hit_dice:
                          type: string
                        speed:
                          type: string
                          readOnly: true
                        strength:
                          type: integer
                          nullable: true
                        dexterity:
                          type: integer
                          nullable: true
                        constitution:
                          type: integer
                          nullable: true
                        intelligence:
                          type: integer
                          nullable: true
                        wisdom:
                          type: integer
                          nullable: true
                        charisma:
                          type: integer
                          nullable: true
                        strength_save:
                          type: integer
                          nullable: true
                        dexterity_save:
                          type: integer
                          nullable: true
                        constitution_save:
                          type: integer
                          nullable: true
                        intelligence_save:
                          type: integer
                          nullable: true
                        wisdom_save:
                          type: integer
                          nullable: true
                        charisma_save:
                          type: integer
                          nullable: true
                        perception:
                          type: integer
                          nullable: true
                        skills:
                          type: string
                          readOnly: true
                        damage_vulnerabilities:
                          type: string
                        damage_resistances:
                          type: string
                        damage_immunities:
                          type: string
                        condition_immunities:
                          type: string
                        senses:
                          type: string
                        languages:
                          type: string
                        challenge_rating:
                          type: string
                          description: Monster challenge rating.
                        cr:
                          type: number
                          nullable: true
                        actions:
                          type: string
                          readOnly: true
                        reactions:
                          type: string
                          readOnly: true
                        legendary_desc:
                          type: string
                        legendary_actions:
                          type: string
                          readOnly: true
                        special_abilities:
                          type: string
                          readOnly: true
                        spell_list:
                          type: array
                          items:
                            type: string
                          readOnly: true
                        page_no:
                          type: integer
                          nullable: true
                        img_main:
                          type: string
                          readOnly: true
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                        document__license_url:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - size
                      - type
                      - subtype
                      - alignment
                      - hit_dice
                      - damage_vulnerabilities
                      - damage_resistances
                      - damage_immunities
                      - condition_immunities
                      - senses
                      - languages
                      - challenge_rating
                      - legendary_desc
          description: ''
      summary: List Monsters
      tags: &id003
      - Monsters
  /monsters/{slug}/:
    get:
      operationId: retrieveMonster
      description: API endpoint for returning a particular monster.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this monster.
        schema:
          type: string
      - name: challenge_rating
        required: false
        in: query
        description: challenge_rating
        schema:
          type: string
      - name: armor_class
        required: false
        in: query
        description: armor_class
        schema:
          type: string
      - name: type
        required: false
        in: query
        description: type
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: page_no
        required: false
        in: query
        description: page_no
        schema:
          type: string
      - name: document
        required: false
        in: query
        description: document
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  slug:
                    type: string
                    maxLength: 255
                  name:
                    type: string
                  size:
                    type: string
                  type:
                    type: string
                  subtype:
                    type: string
                  group:
                    type: string
                    nullable: true
                  alignment:
                    type: string
                  armor_class:
                    type: integer
                  armor_desc:
                    type: string
                    nullable: true
                  hit_points:
                    type: integer
                    nullable: true
                  hit_dice:
                    type: string
                  speed:
                    type: string
                    readOnly: true
                  strength:
                    type: integer
                    nullable: true
                  dexterity:
                    type: integer
                    nullable: true
                  constitution:
                    type: integer
                    nullable: true
                  intelligence:
                    type: integer
                    nullable: true
                  wisdom:
                    type: integer
                    nullable: true
                  charisma:
                    type: integer
                    nullable: true
                  strength_save:
                    type: integer
                    nullable: true
                  dexterity_save:
                    type: integer
                    nullable: true
                  constitution_save:
                    type: integer
                    nullable: true
                  intelligence_save:
                    type: integer
                    nullable: true
                  wisdom_save:
                    type: integer
                    nullable: true
                  charisma_save:
                    type: integer
                    nullable: true
                  perception:
                    type: integer
                    nullable: true
                  skills:
                    type: string
                    readOnly: true
                  damage_vulnerabilities:
                    type: string
                  damage_resistances:
                    type: string
                  damage_immunities:
                    type: string
                  condition_immunities:
                    type: string
                  senses:
                    type: string
                  languages:
                    type: string
                  challenge_rating:
                    type: string
                    description: Monster challenge rating.
                  cr:
                    type: number
                    nullable: true
                  actions:
                    type: string
                    readOnly: true
                  reactions:
                    type: string
                    readOnly: true
                  legendary_desc:
                    type: string
                  legendary_actions:
                    type: string
                    readOnly: true
                  special_abilities:
                    type: string
                    readOnly: true
                  spell_list:
                    type: array
                    items:
                      type: string
                    readOnly: true
                  page_no:
                    type: integer
                    nullable: true
                  img_main:
                    type: string
                    readOnly: true
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                  document__license_url:
                    type: string
                    readOnly: true
                required:
                - name
                - size
                - type
                - subtype
                - alignment
                - hit_dice
                - damage_vulnerabilities
                - damage_resistances
                - damage_immunities
                - condition_immunities
                - senses
                - languages
                - challenge_rating
                - legendary_desc
          description: ''
      summary: Retrieve Monster
      tags: *id003
  /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: A short, human readable string uniquely identifying this document
        schema:
          type: string
      - name: title
        required: false
        in: query
        description: A short descriptive title of this document
        schema:
          type: string
      - name: organization
        required: false
        in: query
        description: The organization that published the document
        schema:
          type: string
      - name: license
        required: false
        in: query
        description: The license under which the document is published
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        title:
                          type: string
                        slug:
                          type: string
                          maxLength: 255
                        url:
                          type: string
                          format: uri
                          maxLength: 200
                          pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:\\S+(?::\\S*)?@)?(?:(?:25[0-5]|2[0-4]\\\
                            d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
                            d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
                            -\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
                            -\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
                            .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
                        license:
                          type: string
                        desc:
                          type: string
                        author:
                          type: string
                        organization:
                          type: string
                        version:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                          readOnly: true
                        copyright:
                          type: string
                          nullable: true
                        license_url:
                          type: string
                      required:
                      - title
                      - url
                      - license
                      - desc
                      - author
                      - organization
                      - version
          description: ''
      summary: List Documents
      tags: &id004
      - 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: A short, human readable string uniquely identifying this document
        schema:
          type: string
      - name: title
        required: false
        in: query
        description: A short descriptive title of this document
        schema:
          type: string
      - name: organization
        required: false
        in: query
        description: The organization that published the document
        schema:
          type: string
      - name: license
        required: false
        in: query
        description: The license under which the document is published
        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:
                properties:
                  title:
                    type: string
                  slug:
                    type: string
                    maxLength: 255
                  url:
                    type: string
                    format: uri
                    maxLength: 200
                    pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:\\S+(?::\\S*)?@)?(?:(?:25[0-5]|2[0-4]\\\
                      d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
                      [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
                      -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
                      .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
                      .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
                  license:
                    type: string
                  desc:
                    type: string
                  author:
                    type: string
                  organization:
                    type: string
                  version:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                    readOnly: true
                  copyright:
                    type: string
                    nullable: true
                  license_url:
                    type: string
                required:
                - title
                - url
                - license
                - desc
                - author
                - organization
                - version
          description: ''
      summary: Retrieve Document
      tags: *id004
  /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: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: skill_proficiencies
        required: false
        in: query
        description: skill_proficiencies
        schema:
          type: string
      - name: languages
        required: false
        in: query
        description: languages
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        name:
                          type: string
                        desc:
                          type: string
                        slug:
                          type: string
                          maxLength: 255
                        skill_proficiencies:
                          type: string
                          nullable: true
                        tool_proficiencies:
                          type: string
                          nullable: true
                        languages:
                          type: string
                          nullable: true
                        equipment:
                          type: string
                        feature:
                          type: string
                        feature_desc:
                          type: string
                        suggested_characteristics:
                          type: string
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                        document__license_url:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - desc
                      - equipment
                      - feature
                      - feature_desc
                      - suggested_characteristics
          description: ''
      summary: List Backgrounds
      tags: &id005
      - Backgrounds
  /backgrounds/{slug}/:
    get:
      operationId: retrieveBackground
      description: API endpoint for returning a particular background.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this background.
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: skill_proficiencies
        required: false
        in: query
        description: skill_proficiencies
        schema:
          type: string
      - name: languages
        required: false
        in: query
        description: languages
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  name:
                    type: string
                  desc:
                    type: string
                  slug:
                    type: string
                    maxLength: 255
                  skill_proficiencies:
                    type: string
                    nullable: true
                  tool_proficiencies:
                    type: string
                    nullable: true
                  languages:
                    type: string
                    nullable: true
                  equipment:
                    type: string
                  feature:
                    type: string
                  feature_desc:
                    type: string
                  suggested_characteristics:
                    type: string
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                  document__license_url:
                    type: string
                    readOnly: true
                required:
                - name
                - desc
                - equipment
                - feature
                - feature_desc
                - suggested_characteristics
          description: ''
      summary: Retrieve Background
      tags: *id005
  /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: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        slug:
                          type: string
                          maxLength: 255
                        name:
                          type: string
                        desc:
                          type: string
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - desc
          description: ''
      summary: List Planes
      tags: &id006
      - Planes
  /planes/{slug}/:
    get:
      operationId: retrievePlane
      description: API endpoint for returning a particular plane.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this plane.
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  slug:
                    type: string
                    maxLength: 255
                  name:
                    type: string
                  desc:
                    type: string
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                required:
                - name
                - desc
          description: ''
      summary: Retrieve Plane
      tags: *id006
  /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: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: parent
        required: false
        in: query
        description: parent
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        slug:
                          type: string
                          maxLength: 255
                        name:
                          type: string
                        desc:
                          type: string
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                        document__license_url:
                          type: string
                          readOnly: true
                        parent:
                          type: string
                          nullable: true
                      required:
                      - name
                      - desc
          description: ''
      summary: List Sections
      tags: &id007
      - Sections
  /sections/{slug}/:
    get:
      operationId: retrieveSection
      description: API endpoint for returning a particular section.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this section.
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: parent
        required: false
        in: query
        description: parent
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  slug:
                    type: string
                    maxLength: 255
                  name:
                    type: string
                  desc:
                    type: string
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                  document__license_url:
                    type: string
                    readOnly: true
                  parent:
                    type: string
                    nullable: true
                required:
                - name
                - desc
          description: ''
      summary: Retrieve Section
      tags: *id007
  /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: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: prerequisite
        required: false
        in: query
        description: prerequisite
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        slug:
                          type: string
                          maxLength: 255
                        name:
                          type: string
                        desc:
                          type: string
                        prerequisite:
                          type: string
                          nullable: true
                        effects_desc:
                          type: string
                          readOnly: true
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - desc
          description: ''
      summary: List Feats
      tags: &id008
      - Feats
  /feats/{slug}/:
    get:
      operationId: retrieveFeat
      description: API endpoint for returning a particular feat.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this feat.
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: prerequisite
        required: false
        in: query
        description: prerequisite
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  slug:
                    type: string
                    maxLength: 255
                  name:
                    type: string
                  desc:
                    type: string
                  prerequisite:
                    type: string
                    nullable: true
                  effects_desc:
                    type: string
                    readOnly: true
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                required:
                - name
                - desc
          description: ''
      summary: Retrieve Feat
      tags: *id008
  /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: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        slug:
                          type: string
                          maxLength: 255
                        name:
                          type: string
                        desc:
                          type: string
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - desc
          description: ''
      summary: List Conditions
      tags: &id009
      - Conditions
  /conditions/{slug}/:
    get:
      operationId: retrieveCondition
      description: API endpoint for returning a particular condition.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this condition.
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  slug:
                    type: string
                    maxLength: 255
                  name:
                    type: string
                  desc:
                    type: string
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                required:
                - name
                - desc
          description: ''
      summary: Retrieve Condition
      tags: *id009
  /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: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        name:
                          type: string
                        slug:
                          type: string
                          maxLength: 255
                        desc:
                          type: string
                        asi_desc:
                          type: string
                        asi:
                          type: string
                          readOnly: true
                        age:
                          type: string
                        alignment:
                          type: string
                        size:
                          type: string
                        speed:
                          type: string
                          readOnly: true
                        speed_desc:
                          type: string
                        languages:
                          type: string
                        vision:
                          type: string
                        traits:
                          type: string
                        subraces:
                          type: array
                          items:
                            properties:
                              name:
                                type: string
                              slug:
                                type: string
                                maxLength: 255
                              desc:
                                type: string
                              asi:
                                type: string
                                readOnly: true
                              traits:
                                type: string
                              asi_desc:
                                type: string
                              document__slug:
                                type: string
                                readOnly: true
                              document__title:
                                type: string
                                readOnly: true
                            required:
                            - name
                            - desc
                            - traits
                            - asi_desc
                          readOnly: true
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                        document__license_url:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - desc
                      - asi_desc
                      - age
                      - alignment
                      - size
                      - speed_desc
                      - languages
                      - vision
                      - traits
          description: ''
      summary: List Races
      tags: &id010
      - Races
  /races/{slug}/:
    get:
      operationId: retrieveRace
      description: API endpoint for returning a particular race.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this race.
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  name:
                    type: string
                  slug:
                    type: string
                    maxLength: 255
                  desc:
                    type: string
                  asi_desc:
                    type: string
                  asi:
                    type: string
                    readOnly: true
                  age:
                    type: string
                  alignment:
                    type: string
                  size:
                    type: string
                  speed:
                    type: string
                    readOnly: true
                  speed_desc:
                    type: string
                  languages:
                    type: string
                  vision:
                    type: string
                  traits:
                    type: string
                  subraces:
                    type: array
                    items:
                      properties:
                        name:
                          type: string
                        slug:
                          type: string
                          maxLength: 255
                        desc:
                          type: string
                        asi:
                          type: string
                          readOnly: true
                        traits:
                          type: string
                        asi_desc:
                          type: string
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - desc
                      - traits
                      - asi_desc
                    readOnly: true
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                  document__license_url:
                    type: string
                    readOnly: true
                required:
                - name
                - desc
                - asi_desc
                - age
                - alignment
                - size
                - speed_desc
                - languages
                - vision
                - traits
          description: ''
      summary: Retrieve Race
      tags: *id010
  /classes/:
    get:
      operationId: listCharClass
      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: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        name:
                          type: string
                        slug:
                          type: string
                          maxLength: 255
                        desc:
                          type: string
                        hit_dice:
                          type: string
                        hp_at_1st_level:
                          type: string
                        hp_at_higher_levels:
                          type: string
                        prof_armor:
                          type: string
                        prof_weapons:
                          type: string
                        prof_tools:
                          type: string
                        prof_saving_throws:
                          type: string
                        prof_skills:
                          type: string
                        equipment:
                          type: string
                        table:
                          type: string
                        spellcasting_ability:
                          type: string
                        subtypes_name:
                          type: string
                        archetypes:
                          type: array
                          items:
                            properties:
                              name:
                                type: string
                              slug:
                                type: string
                                maxLength: 255
                              desc:
                                type: string
                              document__slug:
                                type: string
                                readOnly: true
                              document__title:
                                type: string
                                readOnly: true
                              document__license_url:
                                type: string
                                readOnly: true
                            required:
                            - name
                            - desc
                          readOnly: true
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                        document__license_url:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - desc
                      - hit_dice
                      - hp_at_1st_level
                      - hp_at_higher_levels
                      - prof_armor
                      - prof_weapons
                      - prof_tools
                      - prof_saving_throws
                      - prof_skills
                      - equipment
                      - table
                      - spellcasting_ability
                      - subtypes_name
          description: ''
      summary: List Classes
      tags: &id011
      - Classes
  /classes/{slug}/:
    get:
      operationId: retrieveCharClass
      description: API endpoint for returning a particular class or archetype.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this char class.
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  name:
                    type: string
                  slug:
                    type: string
                    maxLength: 255
                  desc:
                    type: string
                  hit_dice:
                    type: string
                  hp_at_1st_level:
                    type: string
                  hp_at_higher_levels:
                    type: string
                  prof_armor:
                    type: string
                  prof_weapons:
                    type: string
                  prof_tools:
                    type: string
                  prof_saving_throws:
                    type: string
                  prof_skills:
                    type: string
                  equipment:
                    type: string
                  table:
                    type: string
                  spellcasting_ability:
                    type: string
                  subtypes_name:
                    type: string
                  archetypes:
                    type: array
                    items:
                      properties:
                        name:
                          type: string
                        slug:
                          type: string
                          maxLength: 255
                        desc:
                          type: string
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                        document__license_url:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - desc
                    readOnly: true
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                  document__license_url:
                    type: string
                    readOnly: true
                required:
                - name
                - desc
                - hit_dice
                - hp_at_1st_level
                - hp_at_higher_levels
                - prof_armor
                - prof_weapons
                - prof_tools
                - prof_saving_throws
                - prof_skills
                - equipment
                - table
                - spellcasting_ability
                - subtypes_name
          description: ''
      summary: Retrieve Class
      tags: *id011
  /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: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        slug:
                          type: string
                          maxLength: 255
                        name:
                          type: string
                        type:
                          type: string
                        desc:
                          type: string
                        rarity:
                          type: string
                        requires_attunement:
                          type: string
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - type
                      - desc
                      - rarity
                      - requires_attunement
          description: ''
      summary: List Magic Items
      tags: &id012
      - Magic Items
  /magicitems/{slug}/:
    get:
      operationId: retrieveMagicItem
      description: API endpoint for returning a particular magic item.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this magic item.
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  slug:
                    type: string
                    maxLength: 255
                  name:
                    type: string
                  type:
                    type: string
                  desc:
                    type: string
                  rarity:
                    type: string
                  requires_attunement:
                    type: string
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                required:
                - name
                - type
                - desc
                - rarity
                - requires_attunement
          description: ''
      summary: Retrieve Magic Item
      tags: *id012
  /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: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        name:
                          type: string
                        slug:
                          type: string
                          maxLength: 255
                        category:
                          type: string
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                        document__license_url:
                          type: string
                          readOnly: true
                        cost:
                          type: string
                        damage_dice:
                          type: string
                        damage_type:
                          type: string
                        weight:
                          type: string
                        properties:
                          type: string
                          readOnly: true
                      required:
                      - name
                      - category
                      - cost
                      - damage_dice
                      - damage_type
                      - weight
          description: ''
      summary: List Weapons
      tags: &id013
      - Weapons
  /weapons/{slug}/:
    get:
      operationId: retrieveWeapon
      description: API endpoint for returning a particular weapon.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this weapon.
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  name:
                    type: string
                  slug:
                    type: string
                    maxLength: 255
                  category:
                    type: string
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                  document__license_url:
                    type: string
                    readOnly: true
                  cost:
                    type: string
                  damage_dice:
                    type: string
                  damage_type:
                    type: string
                  weight:
                    type: string
                  properties:
                    type: string
                    readOnly: true
                required:
                - name
                - category
                - cost
                - damage_dice
                - damage_type
                - weight
          description: ''
      summary: Retrieve Weapon
      tags: *id013
  /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: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        name:
                          type: string
                        slug:
                          type: string
                          maxLength: 255
                        category:
                          type: string
                        document__slug:
                          type: string
                          readOnly: true
                        document__title:
                          type: string
                          readOnly: true
                        document__license_url:
                          type: string
                          readOnly: true
                        ac_string:
                          type: string
                          readOnly: true
                        strength_requirement:
                          type: integer
                          nullable: true
                        cost:
                          type: string
                        weight:
                          type: string
                        stealth_disadvantage:
                          type: boolean
                      required:
                      - name
                      - category
                      - cost
                      - weight
                      - stealth_disadvantage
          description: ''
      summary: List Armor
      tags: &id014
      - Armor
  /armor/{slug}/:
    get:
      operationId: retrieveArmor
      description: API endpoint for returning a particular armor.
      parameters:
      - name: slug
        in: path
        required: true
        description: A unique value identifying this armor.
        schema:
          type: string
      - name: name
        required: false
        in: query
        description: name
        schema:
          type: string
      - name: document__slug
        required: false
        in: query
        description: document__slug
        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:
                properties:
                  name:
                    type: string
                  slug:
                    type: string
                    maxLength: 255
                  category:
                    type: string
                  document__slug:
                    type: string
                    readOnly: true
                  document__title:
                    type: string
                    readOnly: true
                  document__license_url:
                    type: string
                    readOnly: true
                  ac_string:
                    type: string
                    readOnly: true
                  strength_requirement:
                    type: integer
                    nullable: true
                  cost:
                    type: string
                  weight:
                    type: string
                  stealth_disadvantage:
                    type: boolean
                required:
                - name
                - category
                - cost
                - weight
                - stealth_disadvantage
          description: ''
      summary: Retrieve Armor
      tags: *id014
  /search/:
    get:
      operationId: listAggregates
      description: API endpoint for returning a list of search results from the Open5e
        database.
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        _MonsterIndex__text:
                          type: string
                        _MonsterIndex__name:
                          type: string
                        _MonsterIndex__route:
                          type: string
                        _MonsterIndex__slug:
                          type: string
                          maxLength: 255
                        _MonsterIndex__armor_class:
                          type: string
                        _MonsterIndex__hit_points:
                          type: string
                          nullable: true
                        _MonsterIndex__hit_dice:
                          type: string
                        _MonsterIndex__strength:
                          type: string
                          nullable: true
                        _MonsterIndex__dexterity:
                          type: string
                          nullable: true
                        _MonsterIndex__constitution:
                          type: string
                          nullable: true
                        _MonsterIndex__intelligence:
                          type: string
                          nullable: true
                        _MonsterIndex__wisdom:
                          type: string
                          nullable: true
                        _MonsterIndex__charisma:
                          type: string
                          nullable: true
                        _MonsterIndex__challenge_rating:
                          type: string
                          description: Monster challenge rating.
                        _MonsterIndex__document_slug:
                          type: string
                        _MonsterIndex__document_title:
                          type: string
                        _SpellIndex__document_slug:
                          type: string
                        _SpellIndex__document_title:
                          type: string
                        _SpellIndex__text:
                          type: string
                        _SpellIndex__name:
                          type: string
                        _SpellIndex__route:
                          type: string
                        _SpellIndex__slug:
                          type: string
                          maxLength: 255
                        _SpellIndex__ritual:
                          type: string
                        _SpellIndex__level:
                          type: string
                        _SpellIndex__school:
                          type: string
                        _SpellIndex__dnd_class:
                          type: string
                        _SectionIndex__document_slug:
                          type: string
                        _SectionIndex__document_title:
                          type: string
                        _SectionIndex__text:
                          type: string
                        _SectionIndex__name:
                          type: string
                        _SectionIndex__route:
                          type: string
                        _SectionIndex__slug:
                          type: string
                          maxLength: 255
                        _ConditionIndex__document_slug:
                          type: string
                        _ConditionIndex__document_title:
                          type: string
                        _ConditionIndex__text:
                          type: string
                        _ConditionIndex__name:
                          type: string
                        _ConditionIndex__route:
                          type: string
                        _ConditionIndex__slug:
                          type: string
                          maxLength: 255
                        _CharClassIndex__document_slug:
                          type: string
                        _CharClassIndex__document_title:
                          type: string
                        _CharClassIndex__text:
                          type: string
                        _CharClassIndex__name:
                          type: string
                        _CharClassIndex__route:
                          type: string
                        _CharClassIndex__slug:
                          type: string
                          maxLength: 255
                        _RaceIndex__document_slug:
                          type: string
                        _RaceIndex__document_title:
                          type: string
                        _RaceIndex__text:
                          type: string
                        _RaceIndex__name:
                          type: string
                        _RaceIndex__route:
                          type: string
                        _RaceIndex__slug:
                          type: string
                          maxLength: 255
                        _MagicItemIndex__document_slug:
                          type: string
                        _MagicItemIndex__document_title:
                          type: string
                        _MagicItemIndex__text:
                          type: string
                        _MagicItemIndex__name:
                          type: string
                        _MagicItemIndex__route:
                          type: string
                        _MagicItemIndex__slug:
                          type: string
                          maxLength: 255
                        _MagicItemIndex__type:
                          type: string
                        _MagicItemIndex__rarity:
                          type: string
                        _MagicItemIndex__requires_attunement:
                          type: string
                      required:
                      - _MonsterIndex__text
                      - _MonsterIndex__name
                      - _MonsterIndex__hit_dice
                      - _MonsterIndex__challenge_rating
                      - _MonsterIndex__document_slug
                      - _MonsterIndex__document_title
                      - _SpellIndex__document_slug
                      - _SpellIndex__document_title
                      - _SpellIndex__text
                      - _SpellIndex__name
                      - _SpellIndex__ritual
                      - _SpellIndex__level
                      - _SpellIndex__school
                      - _SpellIndex__dnd_class
                      - _SectionIndex__document_slug
                      - _SectionIndex__document_title
                      - _SectionIndex__text
                      - _SectionIndex__name
                      - _ConditionIndex__document_slug
                      - _ConditionIndex__document_title
                      - _ConditionIndex__text
                      - _ConditionIndex__name
                      - _CharClassIndex__document_slug
                      - _CharClassIndex__document_title
                      - _CharClassIndex__text
                      - _CharClassIndex__name
                      - _RaceIndex__document_slug
                      - _RaceIndex__document_title
                      - _RaceIndex__text
                      - _RaceIndex__name
                      - _MagicItemIndex__document_slug
                      - _MagicItemIndex__document_title
                      - _MagicItemIndex__text
                      - _MagicItemIndex__name
                      - _MagicItemIndex__type
                      - _MagicItemIndex__rarity
                      - _MagicItemIndex__requires_attunement
          description: ''
      summary: Search
      tags:
      - Search
servers:
- url: https://api.open5e.com/
  description: Open5e