diff --git a/404.html b/404.html index e7115e7..365b36d 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ D&D 5e SRD API - + diff --git a/api.html b/api.html index 9e39148..4c9f690 100644 --- a/api.html +++ b/api.html @@ -4,7 +4,7 @@ Get all resource URLs. | D&D 5e SRD API - + diff --git a/api/get-a-background-by-index.html b/api/get-a-background-by-index.html index 61327b7..3b11b2a 100644 --- a/api/get-a-background-by-index.html +++ b/api/get-a-background-by-index.html @@ -4,7 +4,7 @@ Get a background by index. | D&D 5e SRD API - + @@ -13,6 +13,6 @@

Background

Every story has a beginning. Your character's background reveals where you came from, how you became an adventurer, and your place in the world. Choosing a background provides you with important story cues about your character's identity. [SRD p60]

Note: acolyte is the only background included in the SRD.

Path Parameters
index string — REQUIRED

Possible values: [acolyte]

The index of the background to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_proficiencies object[] — OPTIONAL

Starting proficiencies for all new characters of this background.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_equipment object[] — OPTIONAL

Starting equipment for all new characters of this background.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_equipment_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
language_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
feature object — OPTIONAL

Special feature granted to new characters of this background.

name string — OPTIONAL
desc string[] — OPTIONAL
personality_traits object — OPTIONAL

Choice of personality traits for this background.

ideals object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
bonds object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
flaws object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_proficiencies object[] — OPTIONAL

Starting proficiencies for all new characters of this background.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_equipment object[] — OPTIONAL

Starting equipment for all new characters of this background.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_equipment_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
language_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
feature object — OPTIONAL

Special feature granted to new characters of this background.

name string — OPTIONAL
desc string[] — OPTIONAL
personality_traits object — OPTIONAL

Choice of personality traits for this background.

ideals object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
bonds object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
flaws object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
\ No newline at end of file diff --git a/api/get-a-class-by-index.html b/api/get-a-class-by-index.html index 13dbafe..1643508 100644 --- a/api/get-a-class-by-index.html +++ b/api/get-a-class-by-index.html @@ -4,7 +4,7 @@ Get a class by index. | D&D 5e SRD API - + @@ -15,6 +15,6 @@

Class

capabilities, strengths, and weaknesses are largely defined by its class. A character's class affects a character's available skills and abilities. [SRD p8-55]

Path Parameters
index string — REQUIRED

Possible values: [barbarian, bard, cleric, druid, fighter, monk, paladin, ranger, rogue, sorcerer, warlock, wizard]

The index of the class to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

hit_die number — OPTIONAL

Hit die of the class. (ex: 12 == 1d12).

class_levels string — OPTIONAL

URL of the level resource for the class.

multi_classing object — OPTIONAL

Multiclassing

prerequisites object[] — OPTIONAL

List of prerequisites that must be met.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

minimum_score number — OPTIONAL

Minimum score to meet the prerequisite.

prerequisite_options object[] — OPTIONAL

List of choices of prerequisites to meet for.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
proficiencies object[] — OPTIONAL

List of proficiencies available when multiclassing.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

proficiency_choices object[] — OPTIONAL

List of choices of proficiencies that are given when multiclassing.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
spellcasting object — OPTIONAL

Spellcasting

level number — OPTIONAL

Level at which the class can start using its spellcasting abilities.

info object[] — OPTIONAL

Descriptions of the class' ability to cast spells.

name string — OPTIONAL

Feature name.

desc string[] — OPTIONAL

Feature description.

spellcasting_ability object — OPTIONAL

Reference to the AbilityScore used for spellcasting by the class.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

spells string — OPTIONAL

URL of the spell resource list for the class.

starting_equipment object[] — OPTIONAL

List of equipment and their quantities all players of the class start with.

quantity number — OPTIONAL
equipment object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_equipment_options object[] — OPTIONAL

List of choices of starting equipment.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
proficiency_choices object[] — OPTIONAL

List of choices of starting proficiencies.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
proficiencies object[] — OPTIONAL

List of starting proficiencies for all new characters of this class.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

saving_throws object[] — OPTIONAL

Saving throws the class is proficient in.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subclasses object[] — OPTIONAL

List of all possible subclasses this class can specialize in.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

hit_die number — OPTIONAL

Hit die of the class. (ex: 12 == 1d12).

class_levels string — OPTIONAL

URL of the level resource for the class.

multi_classing object — OPTIONAL

Multiclassing

prerequisites object[] — OPTIONAL

List of prerequisites that must be met.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

minimum_score number — OPTIONAL

Minimum score to meet the prerequisite.

prerequisite_options object[] — OPTIONAL

List of choices of prerequisites to meet for.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
proficiencies object[] — OPTIONAL

List of proficiencies available when multiclassing.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

proficiency_choices object[] — OPTIONAL

List of choices of proficiencies that are given when multiclassing.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
spellcasting object — OPTIONAL

Spellcasting

level number — OPTIONAL

Level at which the class can start using its spellcasting abilities.

info object[] — OPTIONAL

Descriptions of the class' ability to cast spells.

name string — OPTIONAL

Feature name.

desc string[] — OPTIONAL

Feature description.

spellcasting_ability object — OPTIONAL

Reference to the AbilityScore used for spellcasting by the class.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

spells string — OPTIONAL

URL of the spell resource list for the class.

starting_equipment object[] — OPTIONAL

List of equipment and their quantities all players of the class start with.

quantity number — OPTIONAL
equipment object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_equipment_options object[] — OPTIONAL

List of choices of starting equipment.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
proficiency_choices object[] — OPTIONAL

List of choices of starting proficiencies.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
proficiencies object[] — OPTIONAL

List of starting proficiencies for all new characters of this class.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

saving_throws object[] — OPTIONAL

Saving throws the class is proficient in.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subclasses object[] — OPTIONAL

List of all possible subclasses this class can specialize in.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-a-condition-by-index.html b/api/get-a-condition-by-index.html index c343f6d..f0a0435 100644 --- a/api/get-a-condition-by-index.html +++ b/api/get-a-condition-by-index.html @@ -4,7 +4,7 @@ Get a condition by index. | D&D 5e SRD API - + @@ -15,6 +15,6 @@

Condition

effect. Most conditions, such as blinded, are impairments, but a few, such as invisible, can be advantageous.

Path Parameters
index string — REQUIRED

Possible values: [blinded, charmed, deafened, exhaustion, frightened, grappled, incapacitated, invisible, paralyzed, petrified, poisoned, prone, restrained, stunned, unconscious]

The index of the condition to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

\ No newline at end of file diff --git a/api/get-a-damage-type-by-index.html b/api/get-a-damage-type-by-index.html index dfb1605..6e9504a 100644 --- a/api/get-a-damage-type-by-index.html +++ b/api/get-a-damage-type-by-index.html @@ -4,7 +4,7 @@ Get a damage type by index. | D&D 5e SRD API - + @@ -14,6 +14,6 @@

Damage type

types of damage. Damage types have no rules of their own, but other rules, such as damage resistance, rely on the types.

Path Parameters
index string — REQUIRED

Possible values: [acid, bludgeoning, cold, fire, force, lightning, necrotic, piercing, poison, psychic, radiant, slashing, thunder]

The index of the damage type to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

\ No newline at end of file diff --git a/api/get-a-feat-by-index.html b/api/get-a-feat-by-index.html index 7c44633..84367de 100644 --- a/api/get-a-feat-by-index.html +++ b/api/get-a-feat-by-index.html @@ -4,7 +4,7 @@ Get a feat by index. | D&D 5e SRD API - + @@ -12,6 +12,6 @@

Feat

A feat is a boon a character can receive at level up instead of an ability score increase.

Path Parameters
index string — REQUIRED

Possible values: [grappler]

The index of the feat to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

prerequisites object[] — OPTIONAL

An object of APIReferences to ability scores and minimum scores.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

minimum_score number — OPTIONAL

Minimum score to meet the prerequisite.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

prerequisites object[] — OPTIONAL

An object of APIReferences to ability scores and minimum scores.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

minimum_score number — OPTIONAL

Minimum score to meet the prerequisite.

\ No newline at end of file diff --git a/api/get-a-feature-by-index.html b/api/get-a-feature-by-index.html index 1b180dc..44ac9e1 100644 --- a/api/get-a-feature-by-index.html +++ b/api/get-a-feature-by-index.html @@ -4,7 +4,7 @@ Get a feature by index. | D&D 5e SRD API - + @@ -16,6 +16,6 @@

Feature

Extra Attack, Unarmored Defense, and Spellcasting.

Path Parameters
index string — REQUIRED

The index of the feature to get.

Available values can be found in the ResourceList for features.

Example: action-surge-1-use

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level number — OPTIONAL

The level this feature is gained.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

class object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subclass object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

parent object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

prerequisites undefined[] — OPTIONAL

The prerequisites for this feature.

feature_specific — OPTIONAL

Information specific to this feature.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

level number — OPTIONAL

The level this feature is gained.

class object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subclass object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

parent object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

prerequisites undefined[] — OPTIONAL

The prerequisites for this feature.

feature_specific — OPTIONAL

Information specific to this feature.

\ No newline at end of file diff --git a/api/get-a-language-by-index.html b/api/get-a-language-by-index.html index ef2834c..006c679 100644 --- a/api/get-a-language-by-index.html +++ b/api/get-a-language-by-index.html @@ -4,7 +4,7 @@ Get a language by index. | D&D 5e SRD API - + @@ -12,6 +12,6 @@

Language

Your race indicates the languages your character can speak by default, and your background might give you access to one or more additional languages of your choice. [SRD p59]

Path Parameters
index string — REQUIRED

Possible values: [abyssal, celestial, common, deep-speech, draconic, dwarvish, elvish, giant, gnomish, goblin, halfling, infernal, orc, primordial, sylvan, undercommon]

The index of the language to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Brief description of the language.

type string — OPTIONAL

Possible values: [Standard, Exotic]

script string — OPTIONAL

Script used for writing in the language.

typical_speakers string[] — OPTIONAL

List of races that tend to speak the language.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Brief description of the language.

type string — OPTIONAL

Possible values: [Standard, Exotic]

script string — OPTIONAL

Script used for writing in the language.

typical_speakers string[] — OPTIONAL

List of races that tend to speak the language.

\ No newline at end of file diff --git a/api/get-a-magic-item-by-index.html b/api/get-a-magic-item-by-index.html index b21cf83..4e10d82 100644 --- a/api/get-a-magic-item-by-index.html +++ b/api/get-a-magic-item-by-index.html @@ -4,7 +4,7 @@ Get a magic item by index. | D&D 5e SRD API - + @@ -12,6 +12,6 @@

These are the various magic items you can find in the game.

Path Parameters
index string — REQUIRED

The index of the magic item to get.

Available values can be found in the resource list for this endpoint.

Example: adamantine-armor

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

equipment_category object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

rarity object — OPTIONAL
name string — OPTIONAL

Possible values: [Varies, Common, Uncommon, Rare, Very Rare, Legendary, Artifact]

The rarity of the item.

variants object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

variant boolean — OPTIONAL

Whether this is a variant or not

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

image string — OPTIONAL

The image url of the magic item.

equipment_category object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

rarity object — OPTIONAL
name string — OPTIONAL

Possible values: [Varies, Common, Uncommon, Rare, Very Rare, Legendary, Artifact]

The rarity of the item.

variants object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

variant boolean — OPTIONAL

Whether this is a variant or not

\ No newline at end of file diff --git a/api/get-a-magic-school-by-index.html b/api/get-a-magic-school-by-index.html index c756900..c63a1f2 100644 --- a/api/get-a-magic-school-by-index.html +++ b/api/get-a-magic-school-by-index.html @@ -4,7 +4,7 @@ Get a magic school by index. | D&D 5e SRD API - + @@ -15,6 +15,6 @@

Magic School

believing that all magic functions in essentially the same way, whether it derives from rigorous study or is bestowed by a deity.

Path Parameters
index string — REQUIRED

Possible values: [abjuration, conjuration, divination, enchantment, evocation, illusion, necromancy, transmutation]

The index of the magic school to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Brief description of the resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Brief description of the resource.

\ No newline at end of file diff --git a/api/get-a-proficiency-by-index.html b/api/get-a-proficiency-by-index.html index 4624e04..496478f 100644 --- a/api/get-a-proficiency-by-index.html +++ b/api/get-a-proficiency-by-index.html @@ -4,7 +4,7 @@ Get a proficiency by index. | D&D 5e SRD API - + @@ -12,6 +12,6 @@

Proficiency

By virtue of race, class, and background a character is proficient at using certain skills, weapons, and equipment. Characters can also gain additional proficiencies at higher levels or by multiclassing. A characters starting proficiencies are determined during character creation.

Path Parameters
index string — REQUIRED

The index of the proficiency to get.

Available values can be found in the ResourceList for proficiencies.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

type string — OPTIONAL

The general category of the proficiency.

classes object[] — OPTIONAL

Classes that start with this proficiency.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

races object[] — OPTIONAL

Races that start with this proficiency.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

reference object — OPTIONAL

APIReference to the full description of the related resource.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

type string — OPTIONAL

The general category of the proficiency.

classes object[] — OPTIONAL

Classes that start with this proficiency.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

races object[] — OPTIONAL

Races that start with this proficiency.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

reference object — OPTIONAL

APIReference to the full description of the related resource.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-a-race-by-index.html b/api/get-a-race-by-index.html index 8ae6ffe..2945cb5 100644 --- a/api/get-a-race-by-index.html +++ b/api/get-a-race-by-index.html @@ -4,13 +4,13 @@ Get a race by index. | D&D 5e SRD API - +
Skip to main content

Get a race by index.

Each race grants your character ability and skill bonuses as well as racial traits.

Path Parameters
index string — REQUIRED

Possible values: [dragonborn, dwarf, elf, gnome, half-elf, half-orc, halfling, human, tiefling]

The index of the race to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

speed number — OPTIONAL

Base move speed for this race (in feet per round).

ability_bonuses object[] — OPTIONAL

Racial bonuses to ability scores.

bonus number — OPTIONAL

Bonus amount for this ability score.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

alignment string — OPTIONAL

Flavor description of likely alignments this race takes.

age string — OPTIONAL

Flavor description of possible ages for this race.

size string — OPTIONAL

Size class of this race.

size_description string — OPTIONAL

Flavor description of height and weight for this race.

starting_proficiencies object[] — OPTIONAL

Starting proficiencies for all new characters of this race.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_proficiency_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
languages object[] — OPTIONAL

Starting languages for all new characters of this race.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

language_desc string — OPTIONAL

Flavor description of the languages this race knows.

traits object[] — OPTIONAL

Racial traits that provide benefits to its members.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subraces object[] — OPTIONAL

All possible subraces that this race includes.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

speed number — OPTIONAL

Base move speed for this race (in feet per round).

ability_bonuses object[] — OPTIONAL

Racial bonuses to ability scores.

bonus number — OPTIONAL

Bonus amount for this ability score.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

alignment string — OPTIONAL

Flavor description of likely alignments this race takes.

age string — OPTIONAL

Flavor description of possible ages for this race.

size string — OPTIONAL

Size class of this race.

size_description string — OPTIONAL

Flavor description of height and weight for this race.

starting_proficiencies object[] — OPTIONAL

Starting proficiencies for all new characters of this race.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_proficiency_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
languages object[] — OPTIONAL

Starting languages for all new characters of this race.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

language_desc string — OPTIONAL

Flavor description of the languages this race knows.

traits object[] — OPTIONAL

Racial traits that provide benefits to its members.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subraces object[] — OPTIONAL

All possible subraces that this race includes.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-a-rule-by-index.html b/api/get-a-rule-by-index.html index 8a4e5ab..e9f2371 100644 --- a/api/get-a-rule-by-index.html +++ b/api/get-a-rule-by-index.html @@ -4,7 +4,7 @@ Get a rule by index. | D&D 5e SRD API - + @@ -14,6 +14,6 @@

Rule

Rules have descriptions which is the text directly underneath the rule heading in the SRD. Rules also have subsections for each heading underneath the rule in the SRD.

Path Parameters
index string — REQUIRED

Possible values: [adventuring, appendix, combat, equipment, spellcasting, using-ability-scores]

The index of the rule to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Description of the rule.

subsections object[] — OPTIONAL

List of sections for each subheading underneath the rule in the SRD.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Description of the rule.

subsections object[] — OPTIONAL

List of sections for each subheading underneath the rule in the SRD.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-a-rule-section-by-index.html b/api/get-a-rule-section-by-index.html index 4f9b621..a9da57a 100644 --- a/api/get-a-rule-section-by-index.html +++ b/api/get-a-rule-section-by-index.html @@ -4,13 +4,13 @@ Get a rule section by index. | D&D 5e SRD API - +
Skip to main content

Get a rule section by index.

Rule sections represent a sub-heading and text that can be found underneath a rule heading in the SRD.

Path Parameters
index string — REQUIRED

Possible values: [ability-checks, ability-scores-and-modifiers, actions-in-combat, activating-an-item, advantage-and-disadvantage, attunement, between-adventures, casting-a-spell, cover, damage-and-healing, diseases, fantasy-historical-pantheons, madness, making-an-attack, mounted-combat, movement, movement-and-position, objects, poisons, proficiency-bonus, resting, saving-throws, sentient-magic-items, standard-exchange-rates, the-environment, the-order-of-combat, the-planes-of-existence, time, traps, underwater-combat, using-each-ability, wearing-and-wielding-items, what-is-a-spell]

The index of the rule section to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Description of the rule.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Description of the rule.

\ No newline at end of file diff --git a/api/get-a-skill-by-index.html b/api/get-a-skill-by-index.html index 6fed69f..265a37b 100644 --- a/api/get-a-skill-by-index.html +++ b/api/get-a-skill-by-index.html @@ -4,7 +4,7 @@ Get a skill by index. | D&D 5e SRD API - + @@ -12,6 +12,6 @@

Skill

Each ability covers a broad range of capabilities, including skills that a character or a monster can be proficient in. A skill represents a specific aspect of an ability score, and an individual's proficiency in a skill demonstrates a focus on that aspect. [SRD p77]

Path Parameters
index string — REQUIRED

Possible values: [acrobatics, animal-handling, arcana, athletics, deception, history, insight, intimidation, investigation, medicine, nature, perception, performance, persuasion, religion, sleight-of-hand, stealth, survival]

The index of the skill to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-a-spell-by-index.html b/api/get-a-spell-by-index.html index 6bf8730..e429115 100644 --- a/api/get-a-spell-by-index.html +++ b/api/get-a-spell-by-index.html @@ -4,16 +4,16 @@ Get a spell by index. | D&D 5e SRD API - +
Skip to main content

Get a spell by index.

Get a spell by index.

Path Parameters
index string — REQUIRED

The index of the Spell to get.

Available values can be found in the ResourceList for spells.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level number — OPTIONAL

Level of the spell.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

higher_level string[] — OPTIONAL

List of descriptions for casting the spell at higher levels.

range string — OPTIONAL

Range of the spell, usually expressed in feet.

components string[] — OPTIONAL

Possible values: [V, S, M]

List of shorthand for required components of the spell. +
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

higher_level string[] — OPTIONAL

List of descriptions for casting the spell at higher levels.

range string — OPTIONAL

Range of the spell, usually expressed in feet.

components string[] — OPTIONAL

Possible values: [V, S, M]

List of shorthand for required components of the spell. V: verbal S: somatic -M: material

material string — OPTIONAL

Material component for the spell to be cast.

area_of_effect object — OPTIONAL
size number — OPTIONAL
type string — OPTIONAL

Possible values: [sphere, cone, cylinder, line, cube]

ritual boolean — OPTIONAL

Determines if a spell can be cast in a 10-min(in-game) ritual.

duration string — OPTIONAL

How long the spell effect lasts.

concentration boolean — OPTIONAL

Determines if a spell needs concentration to persist.

casting_time string — OPTIONAL

How long it takes for the spell to activate.

attack_type string — OPTIONAL

Attack type of the spell.

damage — OPTIONAL
school object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

classes object[] — OPTIONAL

List of classes that are able to learn the spell.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subclasses object[] — OPTIONAL

List of subclasses that have access to the spell.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

Community
More
Copyright © 2024 5e-bits. Built with Docusaurus.
+M: material

material string — OPTIONAL

Material component for the spell to be cast.

area_of_effect object — OPTIONAL
size number — OPTIONAL
type string — OPTIONAL

Possible values: [sphere, cone, cylinder, line, cube]

ritual boolean — OPTIONAL

Determines if a spell can be cast in a 10-min(in-game) ritual.

duration string — OPTIONAL

How long the spell effect lasts.

concentration boolean — OPTIONAL

Determines if a spell needs concentration to persist.

casting_time string — OPTIONAL

How long it takes for the spell to activate.

level number — OPTIONAL

Level of the spell.

attack_type string — OPTIONAL

Attack type of the spell.

damage — OPTIONAL
school object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

classes object[] — OPTIONAL

List of classes that are able to learn the spell.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subclasses object[] — OPTIONAL

List of subclasses that have access to the spell.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-a-subclass-by-index.html b/api/get-a-subclass-by-index.html index 53ccac9..0a4890e 100644 --- a/api/get-a-subclass-by-index.html +++ b/api/get-a-subclass-by-index.html @@ -4,13 +4,13 @@ Get a subclass by index. | D&D 5e SRD API - +
Skip to main content

Get a subclass by index.

Subclasses reflect the different paths a class may take as levels are gained.

Path Parameters
index string — REQUIRED

Possible values: [berserker, champion, devotion, draconic, evocation, fiend, hunter, land, life, lore, open-hand, thief]

The index of the subclass to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

class object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subclass_flavor string — OPTIONAL

Lore-friendly flavor text for a classes respective subclass.

subclass_levels string — OPTIONAL

Resource url that shows the subclass level progression.

spells object[] — OPTIONAL
prerequisites object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

type string — OPTIONAL

The type of prerequisite.

spell object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

class object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subclass_flavor string — OPTIONAL

Lore-friendly flavor text for a classes respective subclass.

subclass_levels string — OPTIONAL

Resource url that shows the subclass level progression.

spells object[] — OPTIONAL
prerequisites object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

type string — OPTIONAL

The type of prerequisite.

spell object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-a-subrace-by-index.html b/api/get-a-subrace-by-index.html index ff53454..ed58fbe 100644 --- a/api/get-a-subrace-by-index.html +++ b/api/get-a-subrace-by-index.html @@ -4,13 +4,13 @@ Get a subrace by index. | D&D 5e SRD API - +
Skip to main content

Get a subrace by index.

Subraces reflect the different varieties of a certain parent race.

Path Parameters
index string — REQUIRED

Possible values: [high-elf, hill-dwarf, lightfoot-halfling, rock-gnome]

The index of the subrace to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Description of the subrace.

race object — OPTIONAL

Parent race for the subrace.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

ability_bonuses object[] — OPTIONAL

Additional ability bonuses for the subrace.

bonus number — OPTIONAL

Bonus amount for this ability score.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_proficiencies object[] — OPTIONAL

Starting proficiencies for all new characters of the subrace.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

languages object[] — OPTIONAL

Starting languages for all new characters of the subrace.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

language_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
racial_traits object[] — OPTIONAL

List of traits that for the subrace.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Description of the subrace.

race object — OPTIONAL

Parent race for the subrace.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

ability_bonuses object[] — OPTIONAL

Additional ability bonuses for the subrace.

bonus number — OPTIONAL

Bonus amount for this ability score.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

starting_proficiencies object[] — OPTIONAL

Starting proficiencies for all new characters of the subrace.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

languages object[] — OPTIONAL

Starting languages for all new characters of the subrace.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

language_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
racial_traits object[] — OPTIONAL

List of traits that for the subrace.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-a-trait-by-index.html b/api/get-a-trait-by-index.html index 0d48497..773bf8e 100644 --- a/api/get-a-trait-by-index.html +++ b/api/get-a-trait-by-index.html @@ -4,13 +4,13 @@ Get a trait by index. | D&D 5e SRD API - +
Skip to main content

Get a trait by index.

Get a trait by index.

Path Parameters
index string — REQUIRED

Possible values: [artificers-lore, brave, breath-weapon, damage-resistance, darkvision, draconic-ancestry, draconic-ancestry-black, draconic-ancestry-blue, draconic-ancestry-brass, draconic-ancestry-bronze, draconic-ancestry-copper, draconic-ancestry-gold, draconic-ancestry-green, draconic-ancestry-red, draconic-ancestry-silver, draconic-ancestry-white, dwarven-combat-training, dwarven-resilience, dwarven-toughness, elf-weapon-training, extra-language, fey-ancestry, gnome-cunning, halfling-nimbleness, hellish-resistance, high-elf-cantrip, infernal-legacy, keen-senses, lucky, menacing, naturally-stealthy, relentless-endurance, savage-attacks, skill-versatility, stonecunning, tinker, tool-proficiency, trance]

The index of the Trait to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

races object[] — OPTIONAL

List of Races that have access to the trait.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subraces object[] — OPTIONAL

List of Subraces that have access to the trait.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

proficiencies object[] — OPTIONAL

List of Proficiencies this trait grants.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

proficiency_choices object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
language_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
trait_specific — OPTIONAL

Information specific to this trait

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

races object[] — OPTIONAL

List of Races that have access to the trait.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subraces object[] — OPTIONAL

List of Subraces that have access to the trait.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

proficiencies object[] — OPTIONAL

List of Proficiencies this trait grants.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

proficiency_choices object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
language_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
trait_specific — OPTIONAL

Information specific to this trait

\ No newline at end of file diff --git a/api/get-a-weapon-property-by-index.html b/api/get-a-weapon-property-by-index.html index de5b983..3f7f4ae 100644 --- a/api/get-a-weapon-property-by-index.html +++ b/api/get-a-weapon-property-by-index.html @@ -4,13 +4,13 @@ Get a weapon property by index. | D&D 5e SRD API - +
Skip to main content

Get a weapon property by index.

Get a weapon property by index.

Path Parameters
index string — REQUIRED

Possible values: [ammunition, finesse, heavy, light, loading, monk, reach, special, thrown, two-handed, versatile]

The index of the weapon property to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

\ No newline at end of file diff --git a/api/get-all-level-resources-for-a-class.html b/api/get-all-level-resources-for-a-class.html index 66c9f7e..afdf22b 100644 --- a/api/get-all-level-resources-for-a-class.html +++ b/api/get-all-level-resources-for-a-class.html @@ -4,7 +4,7 @@ Get all level resources for a class. | D&D 5e SRD API - + @@ -14,6 +14,6 @@
Query Parameters
subclass string

Adds subclasses for class to the response

Example (single-value): berserker

Example (partial-value): ber

-
Responses
200

OK

Schema — OPTIONAL
object[]
index string — OPTIONAL

Resource index for shorthand searching.

url string — OPTIONAL

URL of the referenced resource.

level number — OPTIONAL

The number value for the current level object.

ability_score_bonuses number — OPTIONAL

Total number of ability score bonuses gained, added from previous levels.

prof_bonus number — OPTIONAL

Proficiency bonus for this class at the specified level.

features object[] — OPTIONAL

Features automatically gained at this level.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

spellcasting object — OPTIONAL

Summary of spells known at this level.

cantrips_known number — OPTIONAL
spells_known number — OPTIONAL
spell_slots_level_1 number — OPTIONAL
spell_slots_level_2 number — OPTIONAL
spell_slots_level_3 number — OPTIONAL
spell_slots_level_4 number — OPTIONAL
spell_slots_level_5 number — OPTIONAL
spell_slots_level_6 number — OPTIONAL
spell_slots_level_7 number — OPTIONAL
spell_slots_level_8 number — OPTIONAL
spell_slots_level_9 number — OPTIONAL
class_specific — OPTIONAL

Class specific information such as dice values for bard songs and number of warlock invocations.

+
Responses
200

OK

Schema — OPTIONAL
object[]
index string — OPTIONAL

Resource index for shorthand searching.

url string — OPTIONAL

URL of the referenced resource.

level number — OPTIONAL

The number value for the current level object.

ability_score_bonuses number — OPTIONAL

Total number of ability score bonuses gained, added from previous levels.

prof_bonus number — OPTIONAL

Proficiency bonus for this class at the specified level.

features object[] — OPTIONAL

Features automatically gained at this level.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

spellcasting object — OPTIONAL

Summary of spells known at this level.

cantrips_known number — OPTIONAL
spells_known number — OPTIONAL
spell_slots_level_1 number — OPTIONAL
spell_slots_level_2 number — OPTIONAL
spell_slots_level_3 number — OPTIONAL
spell_slots_level_4 number — OPTIONAL
spell_slots_level_5 number — OPTIONAL
spell_slots_level_6 number — OPTIONAL
spell_slots_level_7 number — OPTIONAL
spell_slots_level_8 number — OPTIONAL
spell_slots_level_9 number — OPTIONAL
class_specific — OPTIONAL

Class specific information such as dice values for bard songs and number of warlock invocations.

\ No newline at end of file diff --git a/api/get-all-level-resources-for-a-subclass.html b/api/get-all-level-resources-for-a-subclass.html index 9146291..6086a5c 100644 --- a/api/get-all-level-resources-for-a-subclass.html +++ b/api/get-all-level-resources-for-a-subclass.html @@ -4,13 +4,13 @@ Get all level resources for a subclass. | D&D 5e SRD API - +
Skip to main content

Get all level resources for a subclass.

Get all level resources for a subclass.

Path Parameters
index string — REQUIRED

Possible values: [berserker, champion, devotion, draconic, evocation, fiend, hunter, land, life, lore, open-hand, thief]

The index of the subclass to get.

-
Responses
200

List of level resource for the subclass.

Schema — OPTIONAL
object[]
index string — OPTIONAL
url string — OPTIONAL
level number — OPTIONAL
features object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

class object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subclass object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

List of level resource for the subclass.

Schema — OPTIONAL
object[]
index string — OPTIONAL
url string — OPTIONAL
level number — OPTIONAL
features object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

class object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

subclass object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-all-resource-ur-ls.html b/api/get-all-resource-ur-ls.html index 6ec9498..a4fa86e 100644 --- a/api/get-all-resource-ur-ls.html +++ b/api/get-all-resource-ur-ls.html @@ -4,7 +4,7 @@ Get all resource URLs. | D&D 5e SRD API - + diff --git a/api/get-an-ability-score-by-index.html b/api/get-an-ability-score-by-index.html index 31ef415..e148300 100644 --- a/api/get-an-ability-score-by-index.html +++ b/api/get-an-ability-score-by-index.html @@ -4,7 +4,7 @@ Get an ability score by index. | D&D 5e SRD API - + @@ -12,6 +12,6 @@

Ability Score

Represents one of the six abilities that describes a creature's physical and mental characteristics. The three main rolls of the game - the ability check, the saving throw, and the attack roll - rely on the ability scores. [SRD p76]

Path Parameters
index string — REQUIRED

Possible values: [cha, con, dex, int, str, wis]

The index of the ability score to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

full_name string — OPTIONAL

Full name of the ability score.

skills object[] — OPTIONAL

List of skills that use this ability score.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

full_name string — OPTIONAL

Full name of the ability score.

skills object[] — OPTIONAL

List of skills that use this ability score.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-an-alignment-by-index.html b/api/get-an-alignment-by-index.html index 5a3b20f..d90b60d 100644 --- a/api/get-an-alignment-by-index.html +++ b/api/get-an-alignment-by-index.html @@ -4,7 +4,7 @@ Get an alignment by index. | D&D 5e SRD API - + @@ -12,6 +12,6 @@

Alignment

A typical creature in the game world has an alignment, which broadly describes its moral and personal attitudes. Alignment is a combination of two factors: one identifies morality (good, evil, or neutral), and the other describes attitudes toward society and order (lawful, chaotic, or neutral). Thus, nine distinct alignments define the possible combinations.[SRD p58]

Path Parameters
index string — REQUIRED

Possible values: [chaotic-neutral, chaotic-evil, chaotic-good, lawful-neutral, lawful-evil, lawful-good, neutral, neutral-evil, neutral-good]

The index of the alignment to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Brief description of the resource.

abbreviation string — OPTIONAL

Abbreviation/initials/acronym for the alignment.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string — OPTIONAL

Brief description of the resource.

abbreviation string — OPTIONAL

Abbreviation/initials/acronym for the alignment.

\ No newline at end of file diff --git a/api/get-an-equipment-category-by-index.html b/api/get-an-equipment-category-by-index.html index f3986a6..4d85dd3 100644 --- a/api/get-an-equipment-category-by-index.html +++ b/api/get-an-equipment-category-by-index.html @@ -4,7 +4,7 @@ Get an equipment category by index. | D&D 5e SRD API - + @@ -12,6 +12,6 @@

These are the categories that various equipment fall under.

Path Parameters
index string — REQUIRED

The index of the equipment category score to get.

Available values can be found in the resource list for this endpoint.

Example: waterborne-vehicles

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

equipment object[] — OPTIONAL

A list of the equipment that falls into this category.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

equipment object[] — OPTIONAL

A list of the equipment that falls into this category.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-an-equipment-item-by-index.html b/api/get-an-equipment-item-by-index.html index 71696fa..eb29dcf 100644 --- a/api/get-an-equipment-item-by-index.html +++ b/api/get-an-equipment-item-by-index.html @@ -4,7 +4,7 @@ Get an equipment item by index. | D&D 5e SRD API - + diff --git a/api/get-features-available-for-a-class.html b/api/get-features-available-for-a-class.html index 4ac7e23..ed28d3b 100644 --- a/api/get-features-available-for-a-class.html +++ b/api/get-features-available-for-a-class.html @@ -4,13 +4,13 @@ Get features available for a class. | D&D 5e SRD API - +
Skip to main content

Get features available for a class.

Get features available for a class.

Path Parameters
index string — REQUIRED

Possible values: [barbarian, bard, cleric, druid, fighter, monk, paladin, ranger, rogue, sorcerer, warlock, wizard]

The index of the class to get.

-
Responses
200

List of features for the class.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

List of features for the class.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-features-available-for-a-subclass.html b/api/get-features-available-for-a-subclass.html index 2f94930..f949160 100644 --- a/api/get-features-available-for-a-subclass.html +++ b/api/get-features-available-for-a-subclass.html @@ -4,13 +4,13 @@ Get features available for a subclass. | D&D 5e SRD API - +
Skip to main content

Get features available for a subclass.

Get features available for a subclass.

Path Parameters
index string — REQUIRED

Possible values: [berserker, champion, devotion, draconic, evocation, fiend, hunter, land, life, lore, open-hand, thief]

The index of the subclass to get.

-
Responses
200

List of features for the subclass.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

List of features for the subclass.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-features-available-to-a-class-at-the-requested-level.html b/api/get-features-available-to-a-class-at-the-requested-level.html index f13c73e..9407acb 100644 --- a/api/get-features-available-to-a-class-at-the-requested-level.html +++ b/api/get-features-available-to-a-class-at-the-requested-level.html @@ -4,13 +4,13 @@ Get features available to a class at the requested level. | D&D 5e SRD API - +
Skip to main content

Get features available to a class at the requested level.

Get features available to a class at the requested level.

Path Parameters
index string — REQUIRED

Possible values: [barbarian, bard, cleric, druid, fighter, monk, paladin, ranger, rogue, sorcerer, warlock, wizard]

The index of the class to get.

class_level number — REQUIRED

Possible values: value ≤ 20

-
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-features-of-the-requested-spell-level-available-to-the-class.html b/api/get-features-of-the-requested-spell-level-available-to-the-class.html index b1bef50..5852485 100644 --- a/api/get-features-of-the-requested-spell-level-available-to-the-class.html +++ b/api/get-features-of-the-requested-spell-level-available-to-the-class.html @@ -4,7 +4,7 @@ Get features of the requested spell level available to the class. | D&D 5e SRD API - + @@ -12,6 +12,6 @@

Get features of the requested spell level available to the class.

Path Parameters
index string — REQUIRED

Possible values: [berserker, champion, devotion, draconic, evocation, fiend, hunter, land, life, lore, open-hand, thief]

The index of the subclass to get.

subclass_level integer — REQUIRED

Possible values: value ≤ 20

Example: 6

-
Responses
200

List of features for the subclass and level.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

List of features for the subclass and level.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-level-resource-for-a-class-and-level.html b/api/get-level-resource-for-a-class-and-level.html index 5d8835b..ffbc1f5 100644 --- a/api/get-level-resource-for-a-class-and-level.html +++ b/api/get-level-resource-for-a-class-and-level.html @@ -4,13 +4,13 @@ Get level resource for a class and level. | D&D 5e SRD API - +
Skip to main content

Get level resource for a class and level.

Get level resource for a class and level.

Path Parameters
index string — REQUIRED

Possible values: [barbarian, bard, cleric, druid, fighter, monk, paladin, ranger, rogue, sorcerer, warlock, wizard]

The index of the class to get.

class_level number — REQUIRED

Possible values: value ≤ 20

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

url string — OPTIONAL

URL of the referenced resource.

level number — OPTIONAL

The number value for the current level object.

ability_score_bonuses number — OPTIONAL

Total number of ability score bonuses gained, added from previous levels.

prof_bonus number — OPTIONAL

Proficiency bonus for this class at the specified level.

features object[] — OPTIONAL

Features automatically gained at this level.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

spellcasting object — OPTIONAL

Summary of spells known at this level.

cantrips_known number — OPTIONAL
spells_known number — OPTIONAL
spell_slots_level_1 number — OPTIONAL
spell_slots_level_2 number — OPTIONAL
spell_slots_level_3 number — OPTIONAL
spell_slots_level_4 number — OPTIONAL
spell_slots_level_5 number — OPTIONAL
spell_slots_level_6 number — OPTIONAL
spell_slots_level_7 number — OPTIONAL
spell_slots_level_8 number — OPTIONAL
spell_slots_level_9 number — OPTIONAL
class_specific — OPTIONAL

Class specific information such as dice values for bard songs and number of warlock invocations.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

url string — OPTIONAL

URL of the referenced resource.

level number — OPTIONAL

The number value for the current level object.

ability_score_bonuses number — OPTIONAL

Total number of ability score bonuses gained, added from previous levels.

prof_bonus number — OPTIONAL

Proficiency bonus for this class at the specified level.

features object[] — OPTIONAL

Features automatically gained at this level.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

spellcasting object — OPTIONAL

Summary of spells known at this level.

cantrips_known number — OPTIONAL
spells_known number — OPTIONAL
spell_slots_level_1 number — OPTIONAL
spell_slots_level_2 number — OPTIONAL
spell_slots_level_3 number — OPTIONAL
spell_slots_level_4 number — OPTIONAL
spell_slots_level_5 number — OPTIONAL
spell_slots_level_6 number — OPTIONAL
spell_slots_level_7 number — OPTIONAL
spell_slots_level_8 number — OPTIONAL
spell_slots_level_9 number — OPTIONAL
class_specific — OPTIONAL

Class specific information such as dice values for bard songs and number of warlock invocations.

\ No newline at end of file diff --git a/api/get-level-resources-for-a-subclass-and-level.html b/api/get-level-resources-for-a-subclass-and-level.html index 1875d25..c197a6c 100644 --- a/api/get-level-resources-for-a-subclass-and-level.html +++ b/api/get-level-resources-for-a-subclass-and-level.html @@ -4,7 +4,7 @@ Get level resources for a subclass and level. | D&D 5e SRD API - + @@ -12,6 +12,6 @@

Get level resources for a subclass and level.

Path Parameters
index string — REQUIRED

Possible values: [berserker, champion, devotion, draconic, evocation, fiend, hunter, land, life, lore, open-hand, thief]

The index of the subclass to get.

subclass_level integer — REQUIRED

Possible values: 1 ≤ value ≤ 20

Example: 6

-
Responses
200

Level resource for the subclass and level.

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

url string — OPTIONAL

URL of the referenced resource.

level number — OPTIONAL

Number value for the current level object.

ability_score_bonuses number — OPTIONAL

Total number of ability score bonuses gained, added from previous levels.

prof_bonus number — OPTIONAL

Proficiency bonus for this class at the specified level.

features object[] — OPTIONAL

List of features gained at this level.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

spellcasting object — OPTIONAL

Summary of spells known at this level.

cantrips_known number — OPTIONAL
spells_known number — OPTIONAL
spell_slots_level_1 number — OPTIONAL
spell_slots_level_2 number — OPTIONAL
spell_slots_level_3 number — OPTIONAL
spell_slots_level_4 number — OPTIONAL
spell_slots_level_5 number — OPTIONAL
spell_slots_level_6 number — OPTIONAL
spell_slots_level_7 number — OPTIONAL
spell_slots_level_8 number — OPTIONAL
spell_slots_level_9 number — OPTIONAL
classspecific — OPTIONAL

Class specific information such as dice values for bard songs and number of warlock invocations.

+
Responses
200

Level resource for the subclass and level.

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

url string — OPTIONAL

URL of the referenced resource.

level number — OPTIONAL

Number value for the current level object.

ability_score_bonuses number — OPTIONAL

Total number of ability score bonuses gained, added from previous levels.

prof_bonus number — OPTIONAL

Proficiency bonus for this class at the specified level.

features object[] — OPTIONAL

List of features gained at this level.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

spellcasting object — OPTIONAL

Summary of spells known at this level.

cantrips_known number — OPTIONAL
spells_known number — OPTIONAL
spell_slots_level_1 number — OPTIONAL
spell_slots_level_2 number — OPTIONAL
spell_slots_level_3 number — OPTIONAL
spell_slots_level_4 number — OPTIONAL
spell_slots_level_5 number — OPTIONAL
spell_slots_level_6 number — OPTIONAL
spell_slots_level_7 number — OPTIONAL
spell_slots_level_8 number — OPTIONAL
spell_slots_level_9 number — OPTIONAL
classspecific — OPTIONAL

Class specific information such as dice values for bard songs and number of warlock invocations.

\ No newline at end of file diff --git a/api/get-list-of-all-available-resources-for-an-endpoint.html b/api/get-list-of-all-available-resources-for-an-endpoint.html index c5b4142..e7bc8fa 100644 --- a/api/get-list-of-all-available-resources-for-an-endpoint.html +++ b/api/get-list-of-all-available-resources-for-an-endpoint.html @@ -4,13 +4,13 @@ Get list of all available resources for an endpoint. | D&D 5e SRD API - +
Skip to main content

Get list of all available resources for an endpoint.

Currently only the /spells and /monsters endpoints support filtering with query parameters. Use of these query parameters is documented under the respective Spells and Monsters sections.

Path Parameters
endpoint string — REQUIRED

Possible values: [ability-scores, alignments, backgrounds, classes, conditions, damage-types, equipment, equipment-categories, feats, features, languages, magic-items, magic-schools, monsters, proficiencies, races, rule-sections, rules, skills, spells, subclasses, subraces, traits, weapon-properties]

-
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-list-of-monsters-with-optional-filtering.html b/api/get-list-of-monsters-with-optional-filtering.html index 3fdecb9..692c75e 100644 --- a/api/get-list-of-monsters-with-optional-filtering.html +++ b/api/get-list-of-monsters-with-optional-filtering.html @@ -4,7 +4,7 @@ Get list of monsters with optional filtering | D&D 5e SRD API - + @@ -14,6 +14,6 @@ 1

Example (multiple-value): 1,2

Example (multiple-value-with-float): 2,0.25

-
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-list-of-spells-with-optional-filtering.html b/api/get-list-of-spells-with-optional-filtering.html index 7527697..fe63ee9 100644 --- a/api/get-list-of-spells-with-optional-filtering.html +++ b/api/get-list-of-spells-with-optional-filtering.html @@ -4,7 +4,7 @@ Get list of spells with optional filtering. | D&D 5e SRD API - + @@ -16,6 +16,6 @@ illusion

Example (multiple-value): evocation,illusion

Example (partial-value): illu

-
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-monster-by-index.html b/api/get-monster-by-index.html index 31a3e5c..9b56ba1 100644 --- a/api/get-monster-by-index.html +++ b/api/get-monster-by-index.html @@ -4,13 +4,13 @@ Get monster by index. | D&D 5e SRD API - +
Skip to main content

Get monster by index.

Get monster by index.

Path Parameters
index string — REQUIRED

The index of the Monster to get.

-
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

charisma number — OPTIONAL

A monster's ability to charm or intimidate a player.

constitution number — OPTIONAL

How sturdy a monster is."

dexterity number — OPTIONAL

The monster's ability for swift movement or stealth

intelligence number — OPTIONAL

The monster's ability to outsmart a player.

strength number — OPTIONAL

How hard a monster can hit a player.

wisdom number — OPTIONAL

A monster's ability to ascertain the player's plan.

image string — OPTIONAL

The image url of the monster.

size string — OPTIONAL

Possible values: [Tiny, Small, Medium, Large, Huge, Gargantuan]

The size of the monster ranging from Tiny to Gargantuan."

type string — OPTIONAL

The type of monster.

subtype string — OPTIONAL

The sub-category of a monster used for classification of monsters."

alignments string — OPTIONAL

Possible values: [chaotic neutral, chaotic evil, chaotic good, lawful neutral, lawful evil, lawful good, neutral, neutral evil, neutral good, any alignment, unaligned]

A creature's general moral and personal attitudes.

armor_class object[] — OPTIONAL

The difficulty for a player to successfully deal damage to a monster.

hit_points number — OPTIONAL

The hit points of a monster determine how much damage it is able to take before it can be defeated.

hit_dice string — OPTIONAL

The hit die of a monster can be used to make a version of the same monster whose hit points are determined by the roll of the die. For example: A monster with 2d6 would have its hit points determine by rolling a 6 sided die twice.

hit_points_roll string — OPTIONAL

The roll for determining a monster's hit points, which consists of the hit dice (e.g. 18d10) and the modifier determined by its Constitution (e.g. +36). For example, 18d10+36

actions object[] — OPTIONAL

A list of actions that are available to the monster to take during combat.

name string — OPTIONAL
desc string — OPTIONAL
action_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
actions object[] — OPTIONAL
action_name string — OPTIONAL
count number — OPTIONAL
type string — OPTIONAL

Possible values: [melee, ranged, ability, magic]

options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
multiattack_type string — OPTIONAL
attack_bonus number — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

attacks object[] — OPTIONAL
name string — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

damage object — OPTIONAL

Damage

damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

damage object[] — OPTIONAL
damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

legendary_actions object[] — OPTIONAL

A list of legendary actions that are available to the monster to take during combat.

name string — OPTIONAL
desc string — OPTIONAL
action_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
actions object[] — OPTIONAL
action_name string — OPTIONAL
count number — OPTIONAL
type string — OPTIONAL

Possible values: [melee, ranged, ability, magic]

options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
multiattack_type string — OPTIONAL
attack_bonus number — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

attacks object[] — OPTIONAL
name string — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

damage object — OPTIONAL

Damage

damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

damage object[] — OPTIONAL
damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

challenge_rating number — OPTIONAL

Possible values: value ≤ 21

A monster's challenge rating is a guideline number that says when a monster becomes an appropriate challenge against the party's average level. For example. A group of 4 players with an average level of 4 would have an appropriate combat challenge against a monster with a challenge rating of 4 but a monster with a challenge rating of 8 against the same group of players would pose a significant threat.

condition_immunities object[] — OPTIONAL

A list of conditions that a monster is immune to.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

damage_immunities string[] — OPTIONAL

A list of damage types that a monster will take double damage from.

damage_resistances string[] — OPTIONAL

A list of damage types that a monster will take half damage from.

damage_vulnerabilities string[] — OPTIONAL

A list of damage types that a monster will take double damage from.

forms object[] — OPTIONAL

List of other related monster entries that are of the same form. Only applicable to Lycanthropes that have multiple forms.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

languages string — OPTIONAL

The languages a monster is able to speak.

proficiencies object[] — OPTIONAL

A list of proficiencies of a monster.

value number — OPTIONAL
proficiency object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

reactions object[] — OPTIONAL

A list of reactions that is available to the monster to take during combat.

name string — OPTIONAL
desc string — OPTIONAL
action_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
actions object[] — OPTIONAL
action_name string — OPTIONAL
count number — OPTIONAL
type string — OPTIONAL

Possible values: [melee, ranged, ability, magic]

options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
multiattack_type string — OPTIONAL
attack_bonus number — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

attacks object[] — OPTIONAL
name string — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

damage object — OPTIONAL

Damage

damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

damage object[] — OPTIONAL
damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

senses object — OPTIONAL

Monsters typically have a passive perception but they might also have other senses to detect players.

passive_perception number — OPTIONAL

The monster's passive perception (wisdom) score.

blindsight string — OPTIONAL

A monster with blindsight can perceive its surroundings without relying on sight, within a specific radius.

darkvision string — OPTIONAL

A monster with darkvision can see in the dark within a specific radius.

tremorsense string — OPTIONAL

A monster with tremorsense can detect and pinpoint the origin of vibrations within a specific radius, provided that the monster and the source of the vibrations are in contact with the same ground or substance.

truesight string — OPTIONAL

A monster with truesight can, out to a specific range, see in normal and magical darkness, see invisible creatures and objects, automatically detect visual illusions and succeed on saving throws against them, and perceive the original form of a shapechanger or a creature that is transformed by magic. Furthermore, the monster can see into the Ethereal Plane within the same range.

special_abilities object[] — OPTIONAL

A list of the monster's special abilities.

name string — OPTIONAL
desc string — OPTIONAL
attack_bonus number — OPTIONAL
damage object — OPTIONAL

Damage

damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

spellcasting object — OPTIONAL
ability object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc number — OPTIONAL
modifier number — OPTIONAL
components_required string[] — OPTIONAL
school string — OPTIONAL
slots object — OPTIONAL
spells object[] — OPTIONAL
name string — OPTIONAL
level number — OPTIONAL
url string — OPTIONAL
usage object — OPTIONAL
type string — OPTIONAL

Possible values: [at will, per day, recharge after rest, recharge on roll]

rest_types string[] — OPTIONAL
times number — OPTIONAL
usage object — OPTIONAL
type string — OPTIONAL

Possible values: [at will, per day, recharge after rest, recharge on roll]

rest_types string[] — OPTIONAL
times number — OPTIONAL
speed object — OPTIONAL

Speed for a monster determines how fast it can move per turn.

walk string — OPTIONAL

All creatures have a walking speed, simply called the monster’s speed. Creatures that have no form of ground-based locomotion have a walking speed of 0 feet.

burrow string — OPTIONAL

A monster that has a burrowing speed can use that speed to move through sand, earth, mud, or ice. A monster can’t burrow through solid rock unless it has a special trait that allows it to do so.

climb string — OPTIONAL

A monster that has a climbing speed can use all or part of its movement to move on vertical surfaces. The monster doesn’t need to spend extra movement to climb.

fly string — OPTIONAL

A monster that has a flying speed can use all or part of its movement to fly.

swim string — OPTIONAL

A monster that has a swimming speed doesn’t need to spend extra movement to swim.

xp number — OPTIONAL

The number of experience points (XP) a monster is worth is based on its challenge rating.

+
Responses
200

OK

Schema — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

desc string[] — OPTIONAL

Description of the resource.

charisma number — OPTIONAL

A monster's ability to charm or intimidate a player.

constitution number — OPTIONAL

How sturdy a monster is."

dexterity number — OPTIONAL

The monster's ability for swift movement or stealth

intelligence number — OPTIONAL

The monster's ability to outsmart a player.

strength number — OPTIONAL

How hard a monster can hit a player.

wisdom number — OPTIONAL

A monster's ability to ascertain the player's plan.

image string — OPTIONAL

The image url of the monster.

size string — OPTIONAL

Possible values: [Tiny, Small, Medium, Large, Huge, Gargantuan]

The size of the monster ranging from Tiny to Gargantuan."

type string — OPTIONAL

The type of monster.

subtype string — OPTIONAL

The sub-category of a monster used for classification of monsters."

alignment string — OPTIONAL

A creature's general moral and personal attitudes.

armor_class object[] — OPTIONAL

The difficulty for a player to successfully deal damage to a monster.

hit_points number — OPTIONAL

The hit points of a monster determine how much damage it is able to take before it can be defeated.

hit_dice string — OPTIONAL

The hit die of a monster can be used to make a version of the same monster whose hit points are determined by the roll of the die. For example: A monster with 2d6 would have its hit points determine by rolling a 6 sided die twice.

hit_points_roll string — OPTIONAL

The roll for determining a monster's hit points, which consists of the hit dice (e.g. 18d10) and the modifier determined by its Constitution (e.g. +36). For example, 18d10+36

actions object[] — OPTIONAL

A list of actions that are available to the monster to take during combat.

name string — OPTIONAL
desc string — OPTIONAL
action_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
actions object[] — OPTIONAL
action_name string — OPTIONAL
count number — OPTIONAL
type string — OPTIONAL

Possible values: [melee, ranged, ability, magic]

options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
multiattack_type string — OPTIONAL
attack_bonus number — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

attacks object[] — OPTIONAL
name string — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

damage object — OPTIONAL

Damage

damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

damage object[] — OPTIONAL
damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

legendary_actions object[] — OPTIONAL

A list of legendary actions that are available to the monster to take during combat.

name string — OPTIONAL
desc string — OPTIONAL
action_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
actions object[] — OPTIONAL
action_name string — OPTIONAL
count number — OPTIONAL
type string — OPTIONAL

Possible values: [melee, ranged, ability, magic]

options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
multiattack_type string — OPTIONAL
attack_bonus number — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

attacks object[] — OPTIONAL
name string — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

damage object — OPTIONAL

Damage

damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

damage object[] — OPTIONAL
damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

challenge_rating number — OPTIONAL

Possible values: value ≤ 21

A monster's challenge rating is a guideline number that says when a monster becomes an appropriate challenge against the party's average level. For example. A group of 4 players with an average level of 4 would have an appropriate combat challenge against a monster with a challenge rating of 4 but a monster with a challenge rating of 8 against the same group of players would pose a significant threat.

proficiency_bonus number — OPTIONAL

Possible values: 2 ≤ value ≤ 9

A monster's proficiency bonus is the number added to ability checks, saving throws and attack rolls in which the monster is proficient, and is linked to the monster's challenge rating. This bonus has already been included in the monster's stats where applicable.

condition_immunities object[] — OPTIONAL

A list of conditions that a monster is immune to.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

damage_immunities string[] — OPTIONAL

A list of damage types that a monster will take double damage from.

damage_resistances string[] — OPTIONAL

A list of damage types that a monster will take half damage from.

damage_vulnerabilities string[] — OPTIONAL

A list of damage types that a monster will take double damage from.

forms object[] — OPTIONAL

List of other related monster entries that are of the same form. Only applicable to Lycanthropes that have multiple forms.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

languages string — OPTIONAL

The languages a monster is able to speak.

proficiencies object[] — OPTIONAL

A list of proficiencies of a monster.

value number — OPTIONAL
proficiency object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

reactions object[] — OPTIONAL

A list of reactions that is available to the monster to take during combat.

name string — OPTIONAL
desc string — OPTIONAL
action_options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
actions object[] — OPTIONAL
action_name string — OPTIONAL
count number — OPTIONAL
type string — OPTIONAL

Possible values: [melee, ranged, ability, magic]

options object — OPTIONAL

Choice

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
multiattack_type string — OPTIONAL
attack_bonus number — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

attacks object[] — OPTIONAL
name string — OPTIONAL
dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

damage object — OPTIONAL

Damage

damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

damage object[] — OPTIONAL
damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

senses object — OPTIONAL

Monsters typically have a passive perception but they might also have other senses to detect players.

passive_perception number — OPTIONAL

The monster's passive perception (wisdom) score.

blindsight string — OPTIONAL

A monster with blindsight can perceive its surroundings without relying on sight, within a specific radius.

darkvision string — OPTIONAL

A monster with darkvision can see in the dark within a specific radius.

tremorsense string — OPTIONAL

A monster with tremorsense can detect and pinpoint the origin of vibrations within a specific radius, provided that the monster and the source of the vibrations are in contact with the same ground or substance.

truesight string — OPTIONAL

A monster with truesight can, out to a specific range, see in normal and magical darkness, see invisible creatures and objects, automatically detect visual illusions and succeed on saving throws against them, and perceive the original form of a shapechanger or a creature that is transformed by magic. Furthermore, the monster can see into the Ethereal Plane within the same range.

special_abilities object[] — OPTIONAL

A list of the monster's special abilities.

name string — OPTIONAL
desc string — OPTIONAL
attack_bonus number — OPTIONAL
damage object — OPTIONAL

Damage

damage_dice string — OPTIONAL
damage_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc object — OPTIONAL

DC

dc_type object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc_value number — OPTIONAL

Value to beat

success_type string — OPTIONAL

Result of a successful save. Can be "none", "half", or "other"

spellcasting object — OPTIONAL
ability object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

dc number — OPTIONAL
modifier number — OPTIONAL
components_required string[] — OPTIONAL
school string — OPTIONAL
slots object — OPTIONAL
spells object[] — OPTIONAL
name string — OPTIONAL
level number — OPTIONAL
url string — OPTIONAL
usage object — OPTIONAL
type string — OPTIONAL

Possible values: [at will, per day, recharge after rest, recharge on roll]

rest_types string[] — OPTIONAL
times number — OPTIONAL
usage object — OPTIONAL
type string — OPTIONAL

Possible values: [at will, per day, recharge after rest, recharge on roll]

rest_types string[] — OPTIONAL
times number — OPTIONAL
speed object — OPTIONAL

Speed for a monster determines how fast it can move per turn.

walk string — OPTIONAL

All creatures have a walking speed, simply called the monster’s speed. Creatures that have no form of ground-based locomotion have a walking speed of 0 feet.

burrow string — OPTIONAL

A monster that has a burrowing speed can use that speed to move through sand, earth, mud, or ice. A monster can’t burrow through solid rock unless it has a special trait that allows it to do so.

climb string — OPTIONAL

A monster that has a climbing speed can use all or part of its movement to move on vertical surfaces. The monster doesn’t need to spend extra movement to climb.

fly string — OPTIONAL

A monster that has a flying speed can use all or part of its movement to fly.

swim string — OPTIONAL

A monster that has a swimming speed doesn’t need to spend extra movement to swim.

xp number — OPTIONAL

The number of experience points (XP) a monster is worth is based on its challenge rating.

\ No newline at end of file diff --git a/api/get-multiclassing-resource-for-a-class.html b/api/get-multiclassing-resource-for-a-class.html index d8f732e..f902c4c 100644 --- a/api/get-multiclassing-resource-for-a-class.html +++ b/api/get-multiclassing-resource-for-a-class.html @@ -4,13 +4,13 @@ Get multiclassing resource for a class. | D&D 5e SRD API - +
Skip to main content

Get multiclassing resource for a class.

Get multiclassing resource for a class.

Path Parameters
index string — REQUIRED

Possible values: [barbarian, bard, cleric, druid, fighter, monk, paladin, ranger, rogue, sorcerer, warlock, wizard]

The index of the class to get.

-
Responses
200

OK

Schema — OPTIONAL
prerequisites object[] — OPTIONAL

List of prerequisites that must be met.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

minimum_score number — OPTIONAL

Minimum score to meet the prerequisite.

prerequisite_options object[] — OPTIONAL

List of choices of prerequisites to meet for.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
proficiencies object[] — OPTIONAL

List of proficiencies available when multiclassing.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

proficiency_choices object[] — OPTIONAL

List of choices of proficiencies that are given when multiclassing.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
+
Responses
200

OK

Schema — OPTIONAL
prerequisites object[] — OPTIONAL

List of prerequisites that must be met.

ability_score object — OPTIONAL

APIReference

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

minimum_score number — OPTIONAL

Minimum score to meet the prerequisite.

prerequisite_options object[] — OPTIONAL

List of choices of prerequisites to meet for.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
proficiencies object[] — OPTIONAL

List of proficiencies available when multiclassing.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

proficiency_choices object[] — OPTIONAL

List of choices of proficiencies that are given when multiclassing.

desc string — OPTIONAL

Description of the choice to be made.

choose number — OPTIONAL

Number of items to pick from the list.

type string — OPTIONAL

Type of the resources to choose from.

from (circular) — OPTIONAL
\ No newline at end of file diff --git a/api/get-proficiences-available-for-a-subrace.html b/api/get-proficiences-available-for-a-subrace.html index ad7939c..8cfd560 100644 --- a/api/get-proficiences-available-for-a-subrace.html +++ b/api/get-proficiences-available-for-a-subrace.html @@ -4,13 +4,13 @@ Get proficiences available for a subrace. | D&D 5e SRD API - +
Skip to main content

Get proficiences available for a subrace.

Get proficiences available for a subrace.

Path Parameters
index string — REQUIRED

Possible values: [high-elf, hill-dwarf, lightfoot-halfling, rock-gnome]

The index of the subrace to get.

-
Responses
200

List of proficiences for the subrace.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

List of proficiences for the subrace.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-proficiencies-available-for-a-class.html b/api/get-proficiencies-available-for-a-class.html index b64b8c9..addf38c 100644 --- a/api/get-proficiencies-available-for-a-class.html +++ b/api/get-proficiencies-available-for-a-class.html @@ -4,13 +4,13 @@ Get proficiencies available for a class. | D&D 5e SRD API - +
Skip to main content

Get proficiencies available for a class.

Get proficiencies available for a class.

Path Parameters
index string — REQUIRED

Possible values: [barbarian, bard, cleric, druid, fighter, monk, paladin, ranger, rogue, sorcerer, warlock, wizard]

The index of the class to get.

-
Responses
200

List of proficiencies for the class.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

List of proficiencies for the class.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-proficiencies-available-for-a-race.html b/api/get-proficiencies-available-for-a-race.html index 27e1a1b..795671f 100644 --- a/api/get-proficiencies-available-for-a-race.html +++ b/api/get-proficiencies-available-for-a-race.html @@ -4,13 +4,13 @@ Get proficiencies available for a race. | D&D 5e SRD API - +
Skip to main content

Get proficiencies available for a race.

Get proficiencies available for a race.

Path Parameters
index string — REQUIRED

Possible values: [dragonborn, dwarf, elf, gnome, half-elf, half-orc, halfling, human, tiefling]

The index of the race to get.

-
Responses
200

List of proficiencies for the race.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

List of proficiencies for the race.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-spellcasting-info-for-a-class.html b/api/get-spellcasting-info-for-a-class.html index 6cafa41..10ee343 100644 --- a/api/get-spellcasting-info-for-a-class.html +++ b/api/get-spellcasting-info-for-a-class.html @@ -4,13 +4,13 @@ Get spellcasting info for a class. | D&D 5e SRD API - +
Skip to main content

Get spellcasting info for a class.

Get spellcasting info for a class.

Path Parameters
index string — REQUIRED

Possible values: [barbarian, bard, cleric, druid, fighter, monk, paladin, ranger, rogue, sorcerer, warlock, wizard]

The index of the class to get.

-
Responses
200

OK

Schema — OPTIONAL
level number — OPTIONAL

Level at which the class can start using its spellcasting abilities.

info object[] — OPTIONAL

Descriptions of the class' ability to cast spells.

name string — OPTIONAL

Feature name.

desc string[] — OPTIONAL

Feature description.

spellcasting_ability object — OPTIONAL

Reference to the AbilityScore used for spellcasting by the class.

index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

404

Not found.

Schema — OPTIONAL
error string
+
Responses
200

OK

Schema — OPTIONAL
level number — OPTIONAL

Level at which the class can start using its spellcasting abilities.

info object[] — OPTIONAL

Descriptions of the class' ability to cast spells.

name string — OPTIONAL

Feature name.

desc string[] — OPTIONAL

Feature description.

spellcasting_ability object — OPTIONAL

Reference to the AbilityScore used for spellcasting by the class.

index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

404

Not found.

Schema — OPTIONAL
error string
\ No newline at end of file diff --git a/api/get-spells-available-for-a-class.html b/api/get-spells-available-for-a-class.html index ae6c4ce..e66de27 100644 --- a/api/get-spells-available-for-a-class.html +++ b/api/get-spells-available-for-a-class.html @@ -4,13 +4,13 @@ Get spells available for a class. | D&D 5e SRD API - +
Skip to main content

Get spells available for a class.

Get spells available for a class.

Path Parameters
index string — REQUIRED

Possible values: [barbarian, bard, cleric, druid, fighter, monk, paladin, ranger, rogue, sorcerer, warlock, wizard]

The index of the class to get.

-
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

level number — OPTIONAL

The level of the spell slot used to cast the spell.

\ No newline at end of file diff --git a/api/get-spells-of-the-requested-level-available-to-the-class.html b/api/get-spells-of-the-requested-level-available-to-the-class.html index f8b8b30..96cce30 100644 --- a/api/get-spells-of-the-requested-level-available-to-the-class.html +++ b/api/get-spells-of-the-requested-level-available-to-the-class.html @@ -4,13 +4,13 @@ Get spells of the requested level available to the class. | D&D 5e SRD API - +
Skip to main content

Get spells of the requested level available to the class.

Get spells of the requested level available to the class.

Path Parameters
index string — REQUIRED

Possible values: [barbarian, bard, cleric, druid, fighter, monk, paladin, ranger, rogue, sorcerer, warlock, wizard]

The index of the class to get.

spell_level number — REQUIRED

Possible values: 1 ≤ value ≤ 9

-
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-subclasses-available-for-a-class.html b/api/get-subclasses-available-for-a-class.html index b47364f..9f28129 100644 --- a/api/get-subclasses-available-for-a-class.html +++ b/api/get-subclasses-available-for-a-class.html @@ -4,13 +4,13 @@ Get subclasses available for a class. | D&D 5e SRD API - +
Skip to main content

Get subclasses available for a class.

Get subclasses available for a class.

Path Parameters
index string — REQUIRED

Possible values: [barbarian, bard, cleric, druid, fighter, monk, paladin, ranger, rogue, sorcerer, warlock, wizard]

The index of the class to get.

-
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

OK

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-subraces-available-for-a-race.html b/api/get-subraces-available-for-a-race.html index 2dc1de3..236d517 100644 --- a/api/get-subraces-available-for-a-race.html +++ b/api/get-subraces-available-for-a-race.html @@ -4,13 +4,13 @@ Get subraces available for a race. | D&D 5e SRD API - +
Skip to main content

Get subraces available for a race.

Get subraces available for a race.

Path Parameters
index string — REQUIRED

Possible values: [dragonborn, dwarf, elf, gnome, half-elf, half-orc, halfling, human, tiefling]

The index of the race to get.

-
Responses
200

List of subraces for the race.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

List of subraces for the race.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-traits-available-for-a-race.html b/api/get-traits-available-for-a-race.html index 15ae152..70c710c 100644 --- a/api/get-traits-available-for-a-race.html +++ b/api/get-traits-available-for-a-race.html @@ -4,13 +4,13 @@ Get traits available for a race. | D&D 5e SRD API - +
Skip to main content

Get traits available for a race.

Get traits available for a race.

Path Parameters
index string — REQUIRED

Possible values: [dragonborn, dwarf, elf, gnome, half-elf, half-orc, halfling, human, tiefling]

The index of the race to get.

-
Responses
200

List of traits for the race.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

List of traits for the race.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/api/get-traits-available-for-a-subrace.html b/api/get-traits-available-for-a-subrace.html index ed101dc..36dd1dd 100644 --- a/api/get-traits-available-for-a-subrace.html +++ b/api/get-traits-available-for-a-subrace.html @@ -4,13 +4,13 @@ Get traits available for a subrace. | D&D 5e SRD API - +
Skip to main content

Get traits available for a subrace.

Get traits available for a subrace.

Path Parameters
index string — REQUIRED

Possible values: [high-elf, hill-dwarf, lightfoot-halfling, rock-gnome]

The index of the subrace to get.

-
Responses
200

List of traits for the subrace.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

level integer — OPTIONAL

Level of the referenced resource.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

+
Responses
200

List of traits for the subrace.

Schema — OPTIONAL
count number — OPTIONAL

Total number of resources available.

results object[] — OPTIONAL
index string — OPTIONAL

Resource index for shorthand searching.

name string — OPTIONAL

Name of the referenced resource.

url string — OPTIONAL

URL of the referenced resource.

\ No newline at end of file diff --git a/assets/js/001c3fda.40b2b5c6.js b/assets/js/001c3fda.40b2b5c6.js deleted file mode 100644 index 32848d5..0000000 --- a/assets/js/001c3fda.40b2b5c6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3105],{23190:(e,i,n)=>{n.r(i),n.d(i,{contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var r=n(74848),t=n(28453);const s={},l="Get a feature by index.",o={type:"api",id:"get-a-feature-by-index",title:"Get a feature by index.",description:"",slug:"/get-a-feature-by-index",frontMatter:{},api:{description:"# Feature \n\nWhen you gain a new level in a class, you get its features for that level. \nYou don\u2019t, however, receive the class\u2019s starting Equipment, and a few \nfeatures have additional rules when you\u2019re multiclassing: Channel Divinity, \nExtra Attack, Unarmored Defense, and Spellcasting.\n",tags:["Features"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the feature to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `features`.\n",schema:{type:"string"},example:"action-surge-1-use"}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Feature`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"The level this feature is gained.",type:"number"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},class:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},subclass:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},parent:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},prerequisites:{description:"The prerequisites for this feature.",type:"array",items:{anyOf:[{type:"object",properties:{type:{type:"string"},level:{type:"number"}}},{type:"object",properties:{type:{type:"string"},feature:{type:"string"}}},{type:"object",properties:{type:{type:"string"},spell:{type:"string"}}}]},example:[{type:"level",level:3},{type:"feature",feature:"martial-archetype"},{type:"spell",spell:"shield"}]},feature_specific:{description:"Information specific to this feature.",additionalProperties:!0}}},example:{index:"action-surge-1-use",name:"Action Surge (1 use)",url:"/api/features/action-surge-1-use",class:{index:"fighter",name:"Fighter",url:"/api/classes/fighter"},desc:["Starting at 2nd level, you can push yourself beyond your normal limits for a moment. On your turn, you can take one additional action on top of your regular action and a possible bonus action.","Once you use this feature, you must finish a short or long rest before you can use it again. Starting at 17th level, you can use it twice before a rest, but only once on the same turn."],level:2,prerequisites:[]}}}}},method:"get",path:"/api/features/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a feature by index.",description:{content:"# Feature \n\nWhen you gain a new level in a class, you get its features for that level. \nYou don\u2019t, however, receive the class\u2019s starting Equipment, and a few \nfeatures have additional rules when you\u2019re multiclassing: Channel Divinity, \nExtra Attack, Unarmored Defense, and Spellcasting.\n",type:"text/plain"},url:{path:["api","features",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the feature to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `features`.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-feature-by-index",previous:{title:"Get a feat by index.",permalink:"/docs/api/get-a-feat-by-index"},next:{title:"Get a language by index.",permalink:"/docs/api/get-a-language-by-index"}},a=[];function c(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"get-a-feature-by-index",children:"Get a feature by index."})}),"\n",(0,r.jsx)(i.h1,{id:"feature",children:"Feature"}),"\n",(0,r.jsx)(i.p,{children:"When you gain a new level in a class, you get its features for that level.\nYou don\u2019t, however, receive the class\u2019s starting Equipment, and a few\nfeatures have additional rules when you\u2019re multiclassing: Channel Divinity,\nExtra Attack, Unarmored Defense, and Spellcasting."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,r.jsxs)(i.p,{children:["The ",(0,r.jsx)(i.code,{children:"index"})," of the feature to get."]}),(0,r.jsxs)(i.p,{children:["Available values can be found in the ",(0,r.jsx)(i.a,{href:"#get-/api/-endpoint-",children:(0,r.jsx)(i.code,{children:"ResourceList"})})," for ",(0,r.jsx)(i.code,{children:"features"}),"."]})]}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:["Example:\n",(0,r.jsx)("code",{children:"action-surge-1-use"})]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(i.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"The level this feature is gained."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"class"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:(0,r.jsx)(i.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"subclass"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:(0,r.jsx)(i.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"parent"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:(0,r.jsx)(i.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"prerequisites"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" undefined[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"The prerequisites for this feature."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"feature_specific"}),(0,r.jsx)("span",{style:{opacity:"0.6"}}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Information specific to this feature."})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},28453:(e,i,n)=>{n.d(i,{R:()=>l,x:()=>o});var r=n(96540);const t={},s=r.createContext(t);function l(e){const i=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),r.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/001c3fda.fd051a2c.js b/assets/js/001c3fda.fd051a2c.js new file mode 100644 index 0000000..acca24e --- /dev/null +++ b/assets/js/001c3fda.fd051a2c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3105],{23190:(e,i,n)=>{n.r(i),n.d(i,{contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>a,toc:()=>o});var t=n(74848),r=n(28453);const s={},l="Get a feature by index.",a={type:"api",id:"get-a-feature-by-index",title:"Get a feature by index.",description:"",slug:"/get-a-feature-by-index",frontMatter:{},api:{description:"# Feature \n\nWhen you gain a new level in a class, you get its features for that level. \nYou don\u2019t, however, receive the class\u2019s starting Equipment, and a few \nfeatures have additional rules when you\u2019re multiclassing: Channel Divinity, \nExtra Attack, Unarmored Defense, and Spellcasting.\n",tags:["Features"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the feature to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `features`.\n",schema:{type:"string"},example:"action-surge-1-use"}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Feature`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},level:{description:"The level this feature is gained.",type:"number"},class:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},subclass:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},parent:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},prerequisites:{description:"The prerequisites for this feature.",type:"array",items:{anyOf:[{type:"object",properties:{type:{type:"string"},level:{type:"number"}}},{type:"object",properties:{type:{type:"string"},feature:{type:"string"}}},{type:"object",properties:{type:{type:"string"},spell:{type:"string"}}}]},example:[{type:"level",level:3},{type:"feature",feature:"martial-archetype"},{type:"spell",spell:"shield"}]},feature_specific:{description:"Information specific to this feature.",additionalProperties:!0}}},example:{index:"action-surge-1-use",name:"Action Surge (1 use)",url:"/api/features/action-surge-1-use",class:{index:"fighter",name:"Fighter",url:"/api/classes/fighter"},desc:["Starting at 2nd level, you can push yourself beyond your normal limits for a moment. On your turn, you can take one additional action on top of your regular action and a possible bonus action.","Once you use this feature, you must finish a short or long rest before you can use it again. Starting at 17th level, you can use it twice before a rest, but only once on the same turn."],level:2,prerequisites:[]}}}}},method:"get",path:"/api/features/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a feature by index.",description:{content:"# Feature \n\nWhen you gain a new level in a class, you get its features for that level. \nYou don\u2019t, however, receive the class\u2019s starting Equipment, and a few \nfeatures have additional rules when you\u2019re multiclassing: Channel Divinity, \nExtra Attack, Unarmored Defense, and Spellcasting.\n",type:"text/plain"},url:{path:["api","features",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the feature to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `features`.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-feature-by-index",previous:{title:"Get a feat by index.",permalink:"/docs/api/get-a-feat-by-index"},next:{title:"Get a language by index.",permalink:"/docs/api/get-a-language-by-index"}},o=[];function c(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-a-feature-by-index",children:"Get a feature by index."})}),"\n",(0,t.jsx)(i.h1,{id:"feature",children:"Feature"}),"\n",(0,t.jsx)(i.p,{children:"When you gain a new level in a class, you get its features for that level.\nYou don\u2019t, however, receive the class\u2019s starting Equipment, and a few\nfeatures have additional rules when you\u2019re multiclassing: Channel Divinity,\nExtra Attack, Unarmored Defense, and Spellcasting."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,t.jsxs)(i.p,{children:["The ",(0,t.jsx)(i.code,{children:"index"})," of the feature to get."]}),(0,t.jsxs)(i.p,{children:["Available values can be found in the ",(0,t.jsx)(i.a,{href:"#get-/api/-endpoint-",children:(0,t.jsx)(i.code,{children:"ResourceList"})})," for ",(0,t.jsx)(i.code,{children:"features"}),"."]})]}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["Example:\n",(0,t.jsx)("code",{children:"action-surge-1-use"})]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The level this feature is gained."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"class"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"subclass"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"parent"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"prerequisites"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" undefined[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The prerequisites for this feature."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"feature_specific"}),(0,t.jsx)("span",{style:{opacity:"0.6"}}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Information specific to this feature."})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},28453:(e,i,n)=>{n.d(i,{R:()=>l,x:()=>a});var t=n(96540);const r={},s=t.createContext(r);function l(e){const i=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),t.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/077a73ed.311af8ef.js b/assets/js/077a73ed.311af8ef.js new file mode 100644 index 0000000..48afb56 --- /dev/null +++ b/assets/js/077a73ed.311af8ef.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5437],{43748:(e,i,t)=>{t.r(i),t.d(i,{contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var n=t(74848),r=t(28453);const s={},a="Get a feat by index.",o={type:"api",id:"get-a-feat-by-index",title:"Get a feat by index.",description:"",slug:"/get-a-feat-by-index",frontMatter:{},api:{description:"# Feat \n\nA feat is a boon a character can receive at level up instead of an ability score increase.\n",tags:["Feats"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the feat to get.\n",schema:{type:"string",enum:["grappler"]}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Feat`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},prerequisites:{description:"An object of APIReferences to ability scores and minimum scores.",type:"array",items:{description:"`Prerequisite`\n",type:"object",properties:{ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},minimum_score:{description:"Minimum score to meet the prerequisite.",type:"number"}}}}}},example:{index:"grappler",name:"Grappler",url:"/api/feats/grappler",desc:["You\u2019ve developed the Skills necessary to hold your own in close--quarters Grappling. You gain the following benefits:","- You have advantage on Attack Rolls against a creature you are Grappling.","- You can use your action to try to pin a creature Grappled by you. To do so, make another grapple check. If you succeed, you and the creature are both Restrained until the grapple ends."],prerequisites:[{ability_score:{index:"str",name:"STR",url:"/api/ability-scores/str"},minimum_score:13}]}}}}},method:"get",path:"/api/feats/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a feat by index.",description:{content:"# Feat \n\nA feat is a boon a character can receive at level up instead of an ability score increase.\n",type:"text/plain"},url:{path:["api","feats",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the feat to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-feat-by-index",previous:{title:"Get an equipment category by index.",permalink:"/docs/api/get-an-equipment-category-by-index"},next:{title:"Get a feature by index.",permalink:"/docs/api/get-a-feature-by-index"}},c=[];function l(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-feat-by-index",children:"Get a feat by index."})}),"\n",(0,n.jsx)(i.h1,{id:"feat",children:"Feat"}),"\n",(0,n.jsx)(i.p,{children:"A feat is a boon a character can receive at level up instead of an ability score increase."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"grappler"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the feat to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"prerequisites"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"An object of APIReferences to ability scores and minimum scores."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_score"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"minimum_score"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Minimum score to meet the prerequisite."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>a,x:()=>o});var n=t(96540);const r={},s=n.createContext(r);function a(e){const i=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),n.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/077a73ed.5fa5b140.js b/assets/js/077a73ed.5fa5b140.js deleted file mode 100644 index 60f0323..0000000 --- a/assets/js/077a73ed.5fa5b140.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5437],{43748:(e,i,t)=>{t.r(i),t.d(i,{contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var n=t(74848),r=t(28453);const s={},o="Get a feat by index.",c={type:"api",id:"get-a-feat-by-index",title:"Get a feat by index.",description:"",slug:"/get-a-feat-by-index",frontMatter:{},api:{description:"# Feat \n\nA feat is a boon a character can receive at level up instead of an ability score increase.\n",tags:["Feats"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the feat to get.\n",schema:{type:"string",enum:["grappler"]}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Feat`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},prerequisites:{description:"An object of APIReferences to ability scores and minimum scores.",type:"array",items:{description:"`Prerequisite`\n",type:"object",properties:{ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},minimum_score:{description:"Minimum score to meet the prerequisite.",type:"number"}}}}}},example:{index:"grappler",name:"Grappler",url:"/api/feats/grappler",desc:["You\u2019ve developed the Skills necessary to hold your own in close--quarters Grappling. You gain the following benefits:","- You have advantage on Attack Rolls against a creature you are Grappling.","- You can use your action to try to pin a creature Grappled by you. To do so, make another grapple check. If you succeed, you and the creature are both Restrained until the grapple ends."],prerequisites:[{ability_score:{index:"str",name:"STR",url:"/api/ability-scores/str"},minimum_score:13}]}}}}},method:"get",path:"/api/feats/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a feat by index.",description:{content:"# Feat \n\nA feat is a boon a character can receive at level up instead of an ability score increase.\n",type:"text/plain"},url:{path:["api","feats",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the feat to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-feat-by-index",previous:{title:"Get an equipment category by index.",permalink:"/docs/api/get-an-equipment-category-by-index"},next:{title:"Get a feature by index.",permalink:"/docs/api/get-a-feature-by-index"}},l=[];function a(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-feat-by-index",children:"Get a feat by index."})}),"\n",(0,n.jsx)(i.h1,{id:"feat",children:"Feat"}),"\n",(0,n.jsx)(i.p,{children:"A feat is a boon a character can receive at level up instead of an ability score increase."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"grappler"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the feat to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"prerequisites"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"An object of APIReferences to ability scores and minimum scores."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_score"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"minimum_score"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Minimum score to meet the prerequisite."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>o,x:()=>c});var n=t(96540);const r={},s=n.createContext(r);function o(e){const i=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),n.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0d2c3858.1d2bb598.js b/assets/js/0d2c3858.1d2bb598.js deleted file mode 100644 index 1af4bd0..0000000 --- a/assets/js/0d2c3858.1d2bb598.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9536],{96430:(e,i,n)=>{n.r(i),n.d(i,{contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var t=n(74848),r=n(28453);const s={},l="Get an equipment category by index.",o={type:"api",id:"get-an-equipment-category-by-index",title:"Get an equipment category by index.",description:"",slug:"/get-an-equipment-category-by-index",frontMatter:{},api:{description:"These are the categories that various equipment fall under.",tags:["Equipment"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the equipment category score to get.\n\nAvailable values can be found in the resource list for this endpoint.\n",schema:{type:"string"},example:"waterborne-vehicles"}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`EquipmentCategory`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},equipment:{description:"A list of the equipment that falls into this category.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"waterborne-vehicles",name:"Waterborne Vehicles",url:"/api/equipment-categories/waterborne-vehicles",equipment:[{index:"galley",name:"Galley",url:"/api/equipment/galley"},{index:"keelboat",name:"Keelboat",url:"/api/equipment/keelboat"},{index:"longship",name:"Longship",url:"/api/equipment/longship"},{index:"rowboat",name:"Rowboat",url:"/api/equipment/rowboat"},{index:"sailing-ship",name:"Sailing ship",url:"/api/equipment/sailing-ship"},{index:"warship",name:"Warship",url:"/api/equipment/warship"}]}}}}},method:"get",path:"/api/equipment-categories/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get an equipment category by index.",description:{content:"These are the categories that various equipment fall under.",type:"text/plain"},url:{path:["api","equipment-categories",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the equipment category score to get.\n\nAvailable values can be found in the resource list for this endpoint.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-an-equipment-category-by-index",previous:{title:"Get an equipment item by index.",permalink:"/docs/api/get-an-equipment-item-by-index"},next:{title:"Get a feat by index.",permalink:"/docs/api/get-a-feat-by-index"}},a=[];function c(e){const i={code:"code",h1:"h1",header:"header",p:"p",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-an-equipment-category-by-index",children:"Get an equipment category by index."})}),"\n",(0,t.jsx)(i.p,{children:"These are the categories that various equipment fall under."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,t.jsxs)(i.p,{children:["The ",(0,t.jsx)(i.code,{children:"index"})," of the equipment category score to get."]}),(0,t.jsx)(i.p,{children:"Available values can be found in the resource list for this endpoint."})]}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["Example:\n",(0,t.jsx)("code",{children:"waterborne-vehicles"})]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"equipment"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of the equipment that falls into this category."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},28453:(e,i,n)=>{n.d(i,{R:()=>l,x:()=>o});var t=n(96540);const r={},s=t.createContext(r);function l(e){const i=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),t.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0d2c3858.5c1a3b73.js b/assets/js/0d2c3858.5c1a3b73.js new file mode 100644 index 0000000..c05ab96 --- /dev/null +++ b/assets/js/0d2c3858.5c1a3b73.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9536],{96430:(e,i,n)=>{n.r(i),n.d(i,{contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var t=n(74848),r=n(28453);const s={},a="Get an equipment category by index.",o={type:"api",id:"get-an-equipment-category-by-index",title:"Get an equipment category by index.",description:"",slug:"/get-an-equipment-category-by-index",frontMatter:{},api:{description:"These are the categories that various equipment fall under.",tags:["Equipment"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the equipment category score to get.\n\nAvailable values can be found in the resource list for this endpoint.\n",schema:{type:"string"},example:"waterborne-vehicles"}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`EquipmentCategory`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},equipment:{description:"A list of the equipment that falls into this category.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"waterborne-vehicles",name:"Waterborne Vehicles",url:"/api/equipment-categories/waterborne-vehicles",equipment:[{index:"galley",name:"Galley",url:"/api/equipment/galley"},{index:"keelboat",name:"Keelboat",url:"/api/equipment/keelboat"},{index:"longship",name:"Longship",url:"/api/equipment/longship"},{index:"rowboat",name:"Rowboat",url:"/api/equipment/rowboat"},{index:"sailing-ship",name:"Sailing ship",url:"/api/equipment/sailing-ship"},{index:"warship",name:"Warship",url:"/api/equipment/warship"}]}}}}},method:"get",path:"/api/equipment-categories/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get an equipment category by index.",description:{content:"These are the categories that various equipment fall under.",type:"text/plain"},url:{path:["api","equipment-categories",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the equipment category score to get.\n\nAvailable values can be found in the resource list for this endpoint.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-an-equipment-category-by-index",previous:{title:"Get an equipment item by index.",permalink:"/docs/api/get-an-equipment-item-by-index"},next:{title:"Get a feat by index.",permalink:"/docs/api/get-a-feat-by-index"}},l=[];function c(e){const i={code:"code",h1:"h1",header:"header",p:"p",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-an-equipment-category-by-index",children:"Get an equipment category by index."})}),"\n",(0,t.jsx)(i.p,{children:"These are the categories that various equipment fall under."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,t.jsxs)(i.p,{children:["The ",(0,t.jsx)(i.code,{children:"index"})," of the equipment category score to get."]}),(0,t.jsx)(i.p,{children:"Available values can be found in the resource list for this endpoint."})]}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["Example:\n",(0,t.jsx)("code",{children:"waterborne-vehicles"})]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"equipment"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of the equipment that falls into this category."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},28453:(e,i,n)=>{n.d(i,{R:()=>a,x:()=>o});var t=n(96540);const r={},s=t.createContext(r);function a(e){const i=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/10aca893.9d0ec706.js b/assets/js/10aca893.9d0ec706.js new file mode 100644 index 0000000..7f85906 --- /dev/null +++ b/assets/js/10aca893.9d0ec706.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9951],{34700:(e,i,s)=>{s.r(i),s.d(i,{contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var n=s(74848),t=s(28453);const r={},l="Get a spell by index.",o={type:"api",id:"get-a-spell-by-index",title:"Get a spell by index.",description:"",slug:"/get-a-spell-by-index",frontMatter:{},api:{tags:["Spells"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the `Spell` to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `spells`.\n",schema:{type:"string",example:"sacred-flame"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Spell`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},higher_level:{description:"List of descriptions for casting the spell at higher levels.",type:"array",items:{type:"string"}},range:{description:"Range of the spell, usually expressed in feet.",type:"string"},components:{description:"List of shorthand for required components of the spell.\nV: verbal\nS: somatic\nM: material\n",type:"array",items:{type:"string",enum:["V","S","M"]}},material:{description:"Material component for the spell to be cast.",type:"string"},area_of_effect:{type:"object",properties:{size:{type:"number"},type:{type:"string",enum:["sphere","cone","cylinder","line","cube"]}}},ritual:{description:"Determines if a spell can be cast in a 10-min(in-game) ritual.",type:"boolean"},duration:{description:"How long the spell effect lasts.",type:"string"},concentration:{description:"Determines if a spell needs concentration to persist.",type:"boolean"},casting_time:{description:"How long it takes for the spell to activate.",type:"string"},level:{description:"Level of the spell.",type:"number"},attack_type:{description:"Attack type of the spell.",type:"string"},damage:{oneOf:[{description:"'Spell Damage'\n",type:"object",properties:{damage_at_character_level:{type:"object",additionalProperties:!0},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},{description:"'Spell Damage'\n",type:"object",properties:{damage_at_slot_level:{type:"object",additionalProperties:!0},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}]},school:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},classes:{description:"List of classes that are able to learn the spell.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},subclasses:{description:"List of subclasses that have access to the spell.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"sacred-flame",name:"Sacred Flame",url:"/api/spells/sacred-flame",attack_type:"ranged",casting_time:"1 action",classes:[{index:"cleric",name:"Cleric",url:"/api/classes/cleric"}],components:["V","S"],concentration:!1,damage:{damage_at_character_level:{1:"1d8",5:"2d8",11:"3d8",17:"4d8"},damage_type:{index:"radiant",name:"Radiant",url:"/api/damage-types/radiant"}},dc:{dc_success:"none",dc_type:{index:"dex",name:"DEX",url:"/api/ability-scores/dex"}},desc:["Flame-like radiance descends on a creature that you can see within range. The target must succeed on a dexterity saving throw or take 1d8 radiant damage. The target gains no benefit from cover for this saving throw.","The spell's damage increases by 1d8 when you reach 5th level (2d8), 11th level (3d8), and 17th level (4d8)."],duration:"Instantaneous",higher_level:[],level:0,range:"60 feet",ritual:!1,school:{index:"evocation",name:"Evocation",url:"/api/magic-schools/evocation"},subclasses:[{index:"lore",name:"Lore",url:"/api/subclasses/lore"}]}}}}},description:"Get a spell by index.",method:"get",path:"/api/spells/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a spell by index.",description:{type:"text/plain"},url:{path:["api","spells",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the `Spell` to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `spells`.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-spell-by-index",previous:{title:"Get list of spells with optional filtering.",permalink:"/docs/api/get-list-of-spells-with-optional-filtering"},next:{title:"Get a subclass by index.",permalink:"/docs/api/get-a-subclass-by-index"}},c=[];function a(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-spell-by-index",children:"Get a spell by index."})}),"\n",(0,n.jsx)(i.p,{children:"Get a spell by index."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the ",(0,n.jsx)(i.code,{children:"Spell"})," to get."]}),(0,n.jsxs)(i.p,{children:["Available values can be found in the ",(0,n.jsx)(i.a,{href:"#get-/api/-endpoint-",children:(0,n.jsx)(i.code,{children:"ResourceList"})})," for ",(0,n.jsx)(i.code,{children:"spells"}),"."]})]})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"higher_level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of descriptions for casting the spell at higher levels."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"range"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Range of the spell, usually expressed in feet."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"components"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"V"}),", ",(0,n.jsx)(i.code,{children:"S"}),", ",(0,n.jsx)(i.code,{children:"M"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of shorthand for required components of the spell.\nV: verbal\nS: somatic\nM: material"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"material"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Material component for the spell to be cast."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"area_of_effect"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"size"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"sphere"}),", ",(0,n.jsx)(i.code,{children:"cone"}),", ",(0,n.jsx)(i.code,{children:"cylinder"}),", ",(0,n.jsx)(i.code,{children:"line"}),", ",(0,n.jsx)(i.code,{children:"cube"}),"]"]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ritual"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" boolean"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Determines if a spell can be cast in a 10-min(in-game) ritual."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"duration"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"How long the spell effect lasts."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"concentration"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" boolean"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Determines if a spell needs concentration to persist."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"casting_time"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"How long it takes for the spell to activate."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the spell."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"attack_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Attack type of the spell."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage"}),(0,n.jsx)("span",{style:{opacity:"0.6"}}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"school"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"classes"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of classes that are able to learn the spell."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"subclasses"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of subclasses that have access to the spell."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,i,s)=>{s.d(i,{R:()=>l,x:()=>o});var n=s(96540);const t={},r=n.createContext(t);function l(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/10aca893.e1fd072c.js b/assets/js/10aca893.e1fd072c.js deleted file mode 100644 index de41847..0000000 --- a/assets/js/10aca893.e1fd072c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9951],{34700:(e,i,s)=>{s.r(i),s.d(i,{contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var n=s(74848),t=s(28453);const r={},l="Get a spell by index.",o={type:"api",id:"get-a-spell-by-index",title:"Get a spell by index.",description:"",slug:"/get-a-spell-by-index",frontMatter:{},api:{tags:["Spells"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the `Spell` to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `spells`.\n",schema:{type:"string",example:"sacred-flame"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Spell`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the spell.",type:"number"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},higher_level:{description:"List of descriptions for casting the spell at higher levels.",type:"array",items:{type:"string"}},range:{description:"Range of the spell, usually expressed in feet.",type:"string"},components:{description:"List of shorthand for required components of the spell.\nV: verbal\nS: somatic\nM: material\n",type:"array",items:{type:"string",enum:["V","S","M"]}},material:{description:"Material component for the spell to be cast.",type:"string"},area_of_effect:{type:"object",properties:{size:{type:"number"},type:{type:"string",enum:["sphere","cone","cylinder","line","cube"]}}},ritual:{description:"Determines if a spell can be cast in a 10-min(in-game) ritual.",type:"boolean"},duration:{description:"How long the spell effect lasts.",type:"string"},concentration:{description:"Determines if a spell needs concentration to persist.",type:"boolean"},casting_time:{description:"How long it takes for the spell to activate.",type:"string"},attack_type:{description:"Attack type of the spell.",type:"string"},damage:{oneOf:[{description:"'Spell Damage'\n",type:"object",properties:{damage_at_character_level:{type:"object",additionalProperties:!0},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},{description:"'Spell Damage'\n",type:"object",properties:{damage_at_slot_level:{type:"object",additionalProperties:!0},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}]},school:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},classes:{description:"List of classes that are able to learn the spell.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},subclasses:{description:"List of subclasses that have access to the spell.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"sacred-flame",name:"Sacred Flame",url:"/api/spells/sacred-flame",attack_type:"ranged",casting_time:"1 action",classes:[{index:"cleric",name:"Cleric",url:"/api/classes/cleric"}],components:["V","S"],concentration:!1,damage:{damage_at_character_level:{1:"1d8",5:"2d8",11:"3d8",17:"4d8"},damage_type:{index:"radiant",name:"Radiant",url:"/api/damage-types/radiant"}},dc:{dc_success:"none",dc_type:{index:"dex",name:"DEX",url:"/api/ability-scores/dex"}},desc:["Flame-like radiance descends on a creature that you can see within range. The target must succeed on a dexterity saving throw or take 1d8 radiant damage. The target gains no benefit from cover for this saving throw.","The spell's damage increases by 1d8 when you reach 5th level (2d8), 11th level (3d8), and 17th level (4d8)."],duration:"Instantaneous",higher_level:[],level:0,range:"60 feet",ritual:!1,school:{index:"evocation",name:"Evocation",url:"/api/magic-schools/evocation"},subclasses:[{index:"lore",name:"Lore",url:"/api/subclasses/lore"}]}}}}},description:"Get a spell by index.",method:"get",path:"/api/spells/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a spell by index.",description:{type:"text/plain"},url:{path:["api","spells",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the `Spell` to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `spells`.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-spell-by-index",previous:{title:"Get list of spells with optional filtering.",permalink:"/docs/api/get-list-of-spells-with-optional-filtering"},next:{title:"Get a subclass by index.",permalink:"/docs/api/get-a-subclass-by-index"}},c=[];function a(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-spell-by-index",children:"Get a spell by index."})}),"\n",(0,n.jsx)(i.p,{children:"Get a spell by index."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the ",(0,n.jsx)(i.code,{children:"Spell"})," to get."]}),(0,n.jsxs)(i.p,{children:["Available values can be found in the ",(0,n.jsx)(i.a,{href:"#get-/api/-endpoint-",children:(0,n.jsx)(i.code,{children:"ResourceList"})})," for ",(0,n.jsx)(i.code,{children:"spells"}),"."]})]})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the spell."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"higher_level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of descriptions for casting the spell at higher levels."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"range"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Range of the spell, usually expressed in feet."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"components"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"V"}),", ",(0,n.jsx)(i.code,{children:"S"}),", ",(0,n.jsx)(i.code,{children:"M"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of shorthand for required components of the spell.\nV: verbal\nS: somatic\nM: material"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"material"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Material component for the spell to be cast."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"area_of_effect"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"size"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"sphere"}),", ",(0,n.jsx)(i.code,{children:"cone"}),", ",(0,n.jsx)(i.code,{children:"cylinder"}),", ",(0,n.jsx)(i.code,{children:"line"}),", ",(0,n.jsx)(i.code,{children:"cube"}),"]"]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ritual"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" boolean"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Determines if a spell can be cast in a 10-min(in-game) ritual."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"duration"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"How long the spell effect lasts."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"concentration"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" boolean"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Determines if a spell needs concentration to persist."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"casting_time"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"How long it takes for the spell to activate."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"attack_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Attack type of the spell."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage"}),(0,n.jsx)("span",{style:{opacity:"0.6"}}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"school"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"classes"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of classes that are able to learn the spell."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"subclasses"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of subclasses that have access to the spell."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,i,s)=>{s.d(i,{R:()=>l,x:()=>o});var n=s(96540);const t={},r=n.createContext(t);function l(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1e3dcad6.cf9b1b5f.js b/assets/js/1e3dcad6.cf9b1b5f.js deleted file mode 100644 index 0b5a78a..0000000 --- a/assets/js/1e3dcad6.cf9b1b5f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4574],{69692:(e,i,t)=>{t.r(i),t.d(i,{contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var r=t(74848),n=t(28453);const s={},a="Get traits available for a race.",l={type:"api",id:"get-traits-available-for-a-race",title:"Get traits available for a race.",description:"",slug:"/get-traits-available-for-a-race",frontMatter:{},api:{tags:["Races"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the race to get.\n",schema:{type:"string",enum:["dragonborn","dwarf","elf","gnome","half-elf","half-orc","halfling","human","tiefling"],example:"elf"}}],responses:{200:{description:"List of traits for the race.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get traits available for a race.",method:"get",path:"/api/races/{index}/traits",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get traits available for a race.",description:{type:"text/plain"},url:{path:["api","races",":index","traits"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the race to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-traits-available-for-a-race",previous:{title:"Get proficiencies available for a race.",permalink:"/docs/api/get-proficiencies-available-for-a-race"},next:{title:"Get a rule section by index.",permalink:"/docs/api/get-a-rule-section-by-index"}},c=[];function o(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"get-traits-available-for-a-race",children:"Get traits available for a race."})}),"\n",(0,r.jsx)(i.p,{children:"Get traits available for a race."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"Possible values:"})," [",(0,r.jsx)(i.code,{children:"dragonborn"}),", ",(0,r.jsx)(i.code,{children:"dwarf"}),", ",(0,r.jsx)(i.code,{children:"elf"}),", ",(0,r.jsx)(i.code,{children:"gnome"}),", ",(0,r.jsx)(i.code,{children:"half-elf"}),", ",(0,r.jsx)(i.code,{children:"half-orc"}),", ",(0,r.jsx)(i.code,{children:"halfling"}),", ",(0,r.jsx)(i.code,{children:"human"}),", ",(0,r.jsx)(i.code,{children:"tiefling"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:["The ",(0,r.jsx)(i.code,{children:"index"})," of the race to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(i.p,{children:"List of traits for the race."})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>a,x:()=>l});var r=t(96540);const n={},s=r.createContext(n);function a(e){const i=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),r.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1e3dcad6.d1a94968.js b/assets/js/1e3dcad6.d1a94968.js new file mode 100644 index 0000000..3f96a99 --- /dev/null +++ b/assets/js/1e3dcad6.d1a94968.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4574],{69692:(e,t,i)=>{i.r(t),i.d(t,{contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var r=i(74848),n=i(28453);const s={},a="Get traits available for a race.",l={type:"api",id:"get-traits-available-for-a-race",title:"Get traits available for a race.",description:"",slug:"/get-traits-available-for-a-race",frontMatter:{},api:{tags:["Races"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the race to get.\n",schema:{type:"string",enum:["dragonborn","dwarf","elf","gnome","half-elf","half-orc","halfling","human","tiefling"],example:"elf"}}],responses:{200:{description:"List of traits for the race.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get traits available for a race.",method:"get",path:"/api/races/{index}/traits",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get traits available for a race.",description:{type:"text/plain"},url:{path:["api","races",":index","traits"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the race to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-traits-available-for-a-race",previous:{title:"Get proficiencies available for a race.",permalink:"/docs/api/get-proficiencies-available-for-a-race"},next:{title:"Get a rule section by index.",permalink:"/docs/api/get-a-rule-section-by-index"}},c=[];function o(e){const t={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"get-traits-available-for-a-race",children:"Get traits available for a race."})}),"\n",(0,r.jsx)(t.p,{children:"Get traits available for a race."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Possible values:"})," [",(0,r.jsx)(t.code,{children:"dragonborn"}),", ",(0,r.jsx)(t.code,{children:"dwarf"}),", ",(0,r.jsx)(t.code,{children:"elf"}),", ",(0,r.jsx)(t.code,{children:"gnome"}),", ",(0,r.jsx)(t.code,{children:"half-elf"}),", ",(0,r.jsx)(t.code,{children:"half-orc"}),", ",(0,r.jsx)(t.code,{children:"halfling"}),", ",(0,r.jsx)(t.code,{children:"human"}),", ",(0,r.jsx)(t.code,{children:"tiefling"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(t.p,{children:["The ",(0,r.jsx)(t.code,{children:"index"})," of the race to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(t.p,{children:"List of traits for the race."})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>l});var r=i(96540);const n={},s=r.createContext(n);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/20aea505.565d80e2.js b/assets/js/20aea505.565d80e2.js new file mode 100644 index 0000000..89cbdc9 --- /dev/null +++ b/assets/js/20aea505.565d80e2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9180],{89468:(e,s,i)=>{i.r(s),i.d(s,{contentTitle:()=>a,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>c});var r=i(74848),t=i(28453);const n={},a="Get features available for a class.",l={type:"api",id:"get-features-available-for-a-class",title:"Get features available for a class.",description:"",slug:"/get-features-available-for-a-class",frontMatter:{},api:{tags:["Class Resource Lists"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"List of features for the class.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get features available for a class.",method:"get",path:"/api/classes/{index}/features",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get features available for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","features"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-features-available-for-a-class",previous:{title:"Get spellcasting info for a class.",permalink:"/docs/api/get-spellcasting-info-for-a-class"},next:{title:"Get proficiencies available for a class.",permalink:"/docs/api/get-proficiencies-available-for-a-class"}},c=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"get-features-available-for-a-class",children:"Get features available for a class."})}),"\n",(0,r.jsx)(s.p,{children:"Get features available for a class."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," [",(0,r.jsx)(s.code,{children:"barbarian"}),", ",(0,r.jsx)(s.code,{children:"bard"}),", ",(0,r.jsx)(s.code,{children:"cleric"}),", ",(0,r.jsx)(s.code,{children:"druid"}),", ",(0,r.jsx)(s.code,{children:"fighter"}),", ",(0,r.jsx)(s.code,{children:"monk"}),", ",(0,r.jsx)(s.code,{children:"paladin"}),", ",(0,r.jsx)(s.code,{children:"ranger"}),", ",(0,r.jsx)(s.code,{children:"rogue"}),", ",(0,r.jsx)(s.code,{children:"sorcerer"}),", ",(0,r.jsx)(s.code,{children:"warlock"}),", ",(0,r.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"List of features for the class."})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,s,i)=>{i.d(s,{R:()=>a,x:()=>l});var r=i(96540);const t={},n=r.createContext(t);function a(e){const s=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),r.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/20aea505.632291ce.js b/assets/js/20aea505.632291ce.js deleted file mode 100644 index 30448b4..0000000 --- a/assets/js/20aea505.632291ce.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9180],{89468:(e,s,i)=>{i.r(s),i.d(s,{contentTitle:()=>l,default:()=>d,frontMatter:()=>n,metadata:()=>a,toc:()=>c});var r=i(74848),t=i(28453);const n={},l="Get features available for a class.",a={type:"api",id:"get-features-available-for-a-class",title:"Get features available for a class.",description:"",slug:"/get-features-available-for-a-class",frontMatter:{},api:{tags:["Class Resource Lists"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"List of features for the class.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get features available for a class.",method:"get",path:"/api/classes/{index}/features",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get features available for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","features"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-features-available-for-a-class",previous:{title:"Get spellcasting info for a class.",permalink:"/docs/api/get-spellcasting-info-for-a-class"},next:{title:"Get proficiencies available for a class.",permalink:"/docs/api/get-proficiencies-available-for-a-class"}},c=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"get-features-available-for-a-class",children:"Get features available for a class."})}),"\n",(0,r.jsx)(s.p,{children:"Get features available for a class."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," [",(0,r.jsx)(s.code,{children:"barbarian"}),", ",(0,r.jsx)(s.code,{children:"bard"}),", ",(0,r.jsx)(s.code,{children:"cleric"}),", ",(0,r.jsx)(s.code,{children:"druid"}),", ",(0,r.jsx)(s.code,{children:"fighter"}),", ",(0,r.jsx)(s.code,{children:"monk"}),", ",(0,r.jsx)(s.code,{children:"paladin"}),", ",(0,r.jsx)(s.code,{children:"ranger"}),", ",(0,r.jsx)(s.code,{children:"rogue"}),", ",(0,r.jsx)(s.code,{children:"sorcerer"}),", ",(0,r.jsx)(s.code,{children:"warlock"}),", ",(0,r.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"List of features for the class."})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,s,i)=>{i.d(s,{R:()=>l,x:()=>a});var r=i(96540);const t={},n=r.createContext(t);function l(e){const s=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),r.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/20bf0014.57ecb61a.js b/assets/js/20bf0014.57ecb61a.js deleted file mode 100644 index e5d39ad..0000000 --- a/assets/js/20bf0014.57ecb61a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3162],{37344:(e,n,t)=>{t.r(n),t.d(n,{contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(74848),s=t(28453);const r={},a="Get a rule section by index.",o={type:"api",id:"get-a-rule-section-by-index",title:"Get a rule section by index.",description:"",slug:"/get-a-rule-section-by-index",frontMatter:{},api:{description:"Rule sections represent a sub-heading and text that can be found underneath a rule heading in the SRD.",tags:["Rules"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the rule section to get.\n",schema:{type:"string",enum:["ability-checks","ability-scores-and-modifiers","actions-in-combat","activating-an-item","advantage-and-disadvantage","attunement","between-adventures","casting-a-spell","cover","damage-and-healing","diseases","fantasy-historical-pantheons","madness","making-an-attack","mounted-combat","movement","movement-and-position","objects","poisons","proficiency-bonus","resting","saving-throws","sentient-magic-items","standard-exchange-rates","the-environment","the-order-of-combat","the-planes-of-existence","time","traps","underwater-combat","using-each-ability","wearing-and-wielding-items","what-is-a-spell"],example:"traps"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`RuleSection`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the rule.",type:"string"}}},example:{index:"time",name:"Time",url:"/api/rule-sections/time",desc:"## Time\n\nIn situations where keeping track of the passage of time is important, the GM determines the time a task requires. The GM might use a different time scale depending on the context of the situation at hand. In a dungeon environment, the adventurers' movement happens on a scale of **minutes**. It takes them about a minute to creep down a long hallway, another minute to check for traps on the door at the end of the hall, and a good ten minutes to search the chamber beyond for anything interesting or valuable.\n\nIn a city or wilderness, a scale of **hours** is often more appropriate. Adventurers eager to reach the lonely tower at the heart of the forest hurry across those fifteen miles in just under four hours' time.\n\nFor long journeys, a scale of **days** works best.\n\nFollowing the road from Baldur's Gate to Waterdeep, the adventurers spend four uneventful days before a goblin ambush interrupts their journey.\n\nIn combat and other fast-paced situations, the game relies on **rounds**, a 6-second span of time.\n"}}}}},method:"get",path:"/api/rule-sections/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a rule section by index.",description:{content:"Rule sections represent a sub-heading and text that can be found underneath a rule heading in the SRD.",type:"text/plain"},url:{path:["api","rule-sections",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the rule section to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-rule-section-by-index",previous:{title:"Get traits available for a race.",permalink:"/docs/api/get-traits-available-for-a-race"},next:{title:"Get a rule by index.",permalink:"/docs/api/get-a-rule-by-index"}},d=[];function c(e){const n={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"get-a-rule-section-by-index",children:"Get a rule section by index."})}),"\n",(0,i.jsx)(n.p,{children:"Rule sections represent a sub-heading and text that can be found underneath a rule heading in the SRD."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Possible values:"})," [",(0,i.jsx)(n.code,{children:"ability-checks"}),", ",(0,i.jsx)(n.code,{children:"ability-scores-and-modifiers"}),", ",(0,i.jsx)(n.code,{children:"actions-in-combat"}),", ",(0,i.jsx)(n.code,{children:"activating-an-item"}),", ",(0,i.jsx)(n.code,{children:"advantage-and-disadvantage"}),", ",(0,i.jsx)(n.code,{children:"attunement"}),", ",(0,i.jsx)(n.code,{children:"between-adventures"}),", ",(0,i.jsx)(n.code,{children:"casting-a-spell"}),", ",(0,i.jsx)(n.code,{children:"cover"}),", ",(0,i.jsx)(n.code,{children:"damage-and-healing"}),", ",(0,i.jsx)(n.code,{children:"diseases"}),", ",(0,i.jsx)(n.code,{children:"fantasy-historical-pantheons"}),", ",(0,i.jsx)(n.code,{children:"madness"}),", ",(0,i.jsx)(n.code,{children:"making-an-attack"}),", ",(0,i.jsx)(n.code,{children:"mounted-combat"}),", ",(0,i.jsx)(n.code,{children:"movement"}),", ",(0,i.jsx)(n.code,{children:"movement-and-position"}),", ",(0,i.jsx)(n.code,{children:"objects"}),", ",(0,i.jsx)(n.code,{children:"poisons"}),", ",(0,i.jsx)(n.code,{children:"proficiency-bonus"}),", ",(0,i.jsx)(n.code,{children:"resting"}),", ",(0,i.jsx)(n.code,{children:"saving-throws"}),", ",(0,i.jsx)(n.code,{children:"sentient-magic-items"}),", ",(0,i.jsx)(n.code,{children:"standard-exchange-rates"}),", ",(0,i.jsx)(n.code,{children:"the-environment"}),", ",(0,i.jsx)(n.code,{children:"the-order-of-combat"}),", ",(0,i.jsx)(n.code,{children:"the-planes-of-existence"}),", ",(0,i.jsx)(n.code,{children:"time"}),", ",(0,i.jsx)(n.code,{children:"traps"}),", ",(0,i.jsx)(n.code,{children:"underwater-combat"}),", ",(0,i.jsx)(n.code,{children:"using-each-ability"}),", ",(0,i.jsx)(n.code,{children:"wearing-and-wielding-items"}),", ",(0,i.jsx)(n.code,{children:"what-is-a-spell"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"index"})," of the rule section to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Level of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"desc"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Description of the rule."})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var i=t(96540);const s={},r=i.createContext(s);function a(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/20bf0014.adfb3a3c.js b/assets/js/20bf0014.adfb3a3c.js new file mode 100644 index 0000000..28258d5 --- /dev/null +++ b/assets/js/20bf0014.adfb3a3c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3162],{37344:(e,n,t)=>{t.r(n),t.d(n,{contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(74848),s=t(28453);const r={},a="Get a rule section by index.",o={type:"api",id:"get-a-rule-section-by-index",title:"Get a rule section by index.",description:"",slug:"/get-a-rule-section-by-index",frontMatter:{},api:{description:"Rule sections represent a sub-heading and text that can be found underneath a rule heading in the SRD.",tags:["Rules"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the rule section to get.\n",schema:{type:"string",enum:["ability-checks","ability-scores-and-modifiers","actions-in-combat","activating-an-item","advantage-and-disadvantage","attunement","between-adventures","casting-a-spell","cover","damage-and-healing","diseases","fantasy-historical-pantheons","madness","making-an-attack","mounted-combat","movement","movement-and-position","objects","poisons","proficiency-bonus","resting","saving-throws","sentient-magic-items","standard-exchange-rates","the-environment","the-order-of-combat","the-planes-of-existence","time","traps","underwater-combat","using-each-ability","wearing-and-wielding-items","what-is-a-spell"],example:"traps"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`RuleSection`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the rule.",type:"string"}}},example:{index:"time",name:"Time",url:"/api/rule-sections/time",desc:"## Time\n\nIn situations where keeping track of the passage of time is important, the GM determines the time a task requires. The GM might use a different time scale depending on the context of the situation at hand. In a dungeon environment, the adventurers' movement happens on a scale of **minutes**. It takes them about a minute to creep down a long hallway, another minute to check for traps on the door at the end of the hall, and a good ten minutes to search the chamber beyond for anything interesting or valuable.\n\nIn a city or wilderness, a scale of **hours** is often more appropriate. Adventurers eager to reach the lonely tower at the heart of the forest hurry across those fifteen miles in just under four hours' time.\n\nFor long journeys, a scale of **days** works best.\n\nFollowing the road from Baldur's Gate to Waterdeep, the adventurers spend four uneventful days before a goblin ambush interrupts their journey.\n\nIn combat and other fast-paced situations, the game relies on **rounds**, a 6-second span of time.\n"}}}}},method:"get",path:"/api/rule-sections/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a rule section by index.",description:{content:"Rule sections represent a sub-heading and text that can be found underneath a rule heading in the SRD.",type:"text/plain"},url:{path:["api","rule-sections",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the rule section to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-rule-section-by-index",previous:{title:"Get traits available for a race.",permalink:"/docs/api/get-traits-available-for-a-race"},next:{title:"Get a rule by index.",permalink:"/docs/api/get-a-rule-by-index"}},d=[];function c(e){const n={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"get-a-rule-section-by-index",children:"Get a rule section by index."})}),"\n",(0,i.jsx)(n.p,{children:"Rule sections represent a sub-heading and text that can be found underneath a rule heading in the SRD."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Possible values:"})," [",(0,i.jsx)(n.code,{children:"ability-checks"}),", ",(0,i.jsx)(n.code,{children:"ability-scores-and-modifiers"}),", ",(0,i.jsx)(n.code,{children:"actions-in-combat"}),", ",(0,i.jsx)(n.code,{children:"activating-an-item"}),", ",(0,i.jsx)(n.code,{children:"advantage-and-disadvantage"}),", ",(0,i.jsx)(n.code,{children:"attunement"}),", ",(0,i.jsx)(n.code,{children:"between-adventures"}),", ",(0,i.jsx)(n.code,{children:"casting-a-spell"}),", ",(0,i.jsx)(n.code,{children:"cover"}),", ",(0,i.jsx)(n.code,{children:"damage-and-healing"}),", ",(0,i.jsx)(n.code,{children:"diseases"}),", ",(0,i.jsx)(n.code,{children:"fantasy-historical-pantheons"}),", ",(0,i.jsx)(n.code,{children:"madness"}),", ",(0,i.jsx)(n.code,{children:"making-an-attack"}),", ",(0,i.jsx)(n.code,{children:"mounted-combat"}),", ",(0,i.jsx)(n.code,{children:"movement"}),", ",(0,i.jsx)(n.code,{children:"movement-and-position"}),", ",(0,i.jsx)(n.code,{children:"objects"}),", ",(0,i.jsx)(n.code,{children:"poisons"}),", ",(0,i.jsx)(n.code,{children:"proficiency-bonus"}),", ",(0,i.jsx)(n.code,{children:"resting"}),", ",(0,i.jsx)(n.code,{children:"saving-throws"}),", ",(0,i.jsx)(n.code,{children:"sentient-magic-items"}),", ",(0,i.jsx)(n.code,{children:"standard-exchange-rates"}),", ",(0,i.jsx)(n.code,{children:"the-environment"}),", ",(0,i.jsx)(n.code,{children:"the-order-of-combat"}),", ",(0,i.jsx)(n.code,{children:"the-planes-of-existence"}),", ",(0,i.jsx)(n.code,{children:"time"}),", ",(0,i.jsx)(n.code,{children:"traps"}),", ",(0,i.jsx)(n.code,{children:"underwater-combat"}),", ",(0,i.jsx)(n.code,{children:"using-each-ability"}),", ",(0,i.jsx)(n.code,{children:"wearing-and-wielding-items"}),", ",(0,i.jsx)(n.code,{children:"what-is-a-spell"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"index"})," of the rule section to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"desc"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Description of the rule."})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var i=t(96540);const s={},r=i.createContext(s);function a(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2be17892.8da8276a.js b/assets/js/2be17892.8da8276a.js new file mode 100644 index 0000000..58f3f69 --- /dev/null +++ b/assets/js/2be17892.8da8276a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2917],{42028:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=r(74848),n=r(28453);const s={},c="Get a trait by index.",o={type:"api",id:"get-a-trait-by-index",title:"Get a trait by index.",description:"",slug:"/get-a-trait-by-index",frontMatter:{},api:{tags:["Traits"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the `Trait` to get.",schema:{type:"string",enum:["artificers-lore","brave","breath-weapon","damage-resistance","darkvision","draconic-ancestry","draconic-ancestry-black","draconic-ancestry-blue","draconic-ancestry-brass","draconic-ancestry-bronze","draconic-ancestry-copper","draconic-ancestry-gold","draconic-ancestry-green","draconic-ancestry-red","draconic-ancestry-silver","draconic-ancestry-white","dwarven-combat-training","dwarven-resilience","dwarven-toughness","elf-weapon-training","extra-language","fey-ancestry","gnome-cunning","halfling-nimbleness","hellish-resistance","high-elf-cantrip","infernal-legacy","keen-senses","lucky","menacing","naturally-stealthy","relentless-endurance","savage-attacks","skill-versatility","stonecunning","tinker","tool-proficiency","trance"],example:"trance"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Trait`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},races:{description:"List of `Races` that have access to the trait.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},subraces:{description:"List of `Subraces` that have access to the trait.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},proficiencies:{description:"List of `Proficiencies` this trait grants.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},proficiency_choices:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},language_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},trait_specific:{description:"Information specific to this trait",oneOf:[{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},{type:"object",properties:{"damage-type":{description:"A damage type associated with this trait.",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},"breath-weapon":{description:"The breath weapon action associated with a draconic ancestry.",type:"object",properties:{name:{type:"string"},desc:{type:"string"},area_of_effect:{type:"object",properties:{size:{type:"number"},type:{type:"string",enum:["sphere","cone","cylinder","line","cube"]}}},damage:{type:"object",properties:{damage_at_character_level:{type:"object",additionalProperties:{type:"string"}},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},usage:{description:"Description of the usage constraints of this action.",type:"object",properties:{times:{type:"number"},type:{type:"string"}}}}}}}]}}},example:{index:"trance",name:"Trance",url:"/api/traits/trance",desc:['Elves do not need to sleep. Instead, they meditate deeply, remaining semiconscious, for 4 hours a day. (The Common word for such meditation is "trance.") While meditating, you can dream after a fashion; such dreams are actually mental exercises that have become reflexive through years of practice. After resting this way, you gain the same benefit that a human does from 8 hours of sleep.'],proficiencies:[],races:[{index:"elf",name:"Elf",url:"/api/races/elf"}],subraces:[]}}}}},description:"Get a trait by index.",method:"get",path:"/api/traits/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a trait by index.",description:{type:"text/plain"},url:{path:["api","traits",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the `Trait` to get.",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-trait-by-index",previous:{title:"Get traits available for a subrace.",permalink:"/docs/api/get-traits-available-for-a-subrace"},next:{title:"Get a weapon property by index.",permalink:"/docs/api/get-a-weapon-property-by-index"}},d=[];function a(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-a-trait-by-index",children:"Get a trait by index."})}),"\n",(0,t.jsx)(i.p,{children:"Get a trait by index."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"artificers-lore"}),", ",(0,t.jsx)(i.code,{children:"brave"}),", ",(0,t.jsx)(i.code,{children:"breath-weapon"}),", ",(0,t.jsx)(i.code,{children:"damage-resistance"}),", ",(0,t.jsx)(i.code,{children:"darkvision"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-black"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-blue"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-brass"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-bronze"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-copper"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-gold"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-green"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-red"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-silver"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-white"}),", ",(0,t.jsx)(i.code,{children:"dwarven-combat-training"}),", ",(0,t.jsx)(i.code,{children:"dwarven-resilience"}),", ",(0,t.jsx)(i.code,{children:"dwarven-toughness"}),", ",(0,t.jsx)(i.code,{children:"elf-weapon-training"}),", ",(0,t.jsx)(i.code,{children:"extra-language"}),", ",(0,t.jsx)(i.code,{children:"fey-ancestry"}),", ",(0,t.jsx)(i.code,{children:"gnome-cunning"}),", ",(0,t.jsx)(i.code,{children:"halfling-nimbleness"}),", ",(0,t.jsx)(i.code,{children:"hellish-resistance"}),", ",(0,t.jsx)(i.code,{children:"high-elf-cantrip"}),", ",(0,t.jsx)(i.code,{children:"infernal-legacy"}),", ",(0,t.jsx)(i.code,{children:"keen-senses"}),", ",(0,t.jsx)(i.code,{children:"lucky"}),", ",(0,t.jsx)(i.code,{children:"menacing"}),", ",(0,t.jsx)(i.code,{children:"naturally-stealthy"}),", ",(0,t.jsx)(i.code,{children:"relentless-endurance"}),", ",(0,t.jsx)(i.code,{children:"savage-attacks"}),", ",(0,t.jsx)(i.code,{children:"skill-versatility"}),", ",(0,t.jsx)(i.code,{children:"stonecunning"}),", ",(0,t.jsx)(i.code,{children:"tinker"}),", ",(0,t.jsx)(i.code,{children:"tool-proficiency"}),", ",(0,t.jsx)(i.code,{children:"trance"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["The ",(0,t.jsx)(i.code,{children:"index"})," of the ",(0,t.jsx)(i.code,{children:"Trait"})," to get."]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"races"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["List of ",(0,t.jsx)(i.code,{children:"Races"})," that have access to the trait."]})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"subraces"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["List of ",(0,t.jsx)(i.code,{children:"Subraces"})," that have access to the trait."]})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"proficiencies"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["List of ",(0,t.jsx)(i.code,{children:"Proficiencies"})," this trait grants."]})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"proficiency_choices"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Choice"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"choose"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"from"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"language_options"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Choice"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"choose"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"from"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"trait_specific"}),(0,t.jsx)("span",{style:{opacity:"0.6"}}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Information specific to this trait"})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>c,x:()=>o});var t=r(96540);const n={},s=t.createContext(n);function c(e){const i=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2be17892.91502c44.js b/assets/js/2be17892.91502c44.js deleted file mode 100644 index 947a282..0000000 --- a/assets/js/2be17892.91502c44.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2917],{42028:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>c,default:()=>a,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=r(74848),n=r(28453);const s={},c="Get a trait by index.",o={type:"api",id:"get-a-trait-by-index",title:"Get a trait by index.",description:"",slug:"/get-a-trait-by-index",frontMatter:{},api:{tags:["Traits"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the `Trait` to get.",schema:{type:"string",enum:["artificers-lore","brave","breath-weapon","damage-resistance","darkvision","draconic-ancestry","draconic-ancestry-black","draconic-ancestry-blue","draconic-ancestry-brass","draconic-ancestry-bronze","draconic-ancestry-copper","draconic-ancestry-gold","draconic-ancestry-green","draconic-ancestry-red","draconic-ancestry-silver","draconic-ancestry-white","dwarven-combat-training","dwarven-resilience","dwarven-toughness","elf-weapon-training","extra-language","fey-ancestry","gnome-cunning","halfling-nimbleness","hellish-resistance","high-elf-cantrip","infernal-legacy","keen-senses","lucky","menacing","naturally-stealthy","relentless-endurance","savage-attacks","skill-versatility","stonecunning","tinker","tool-proficiency","trance"],example:"trance"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Trait`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},races:{description:"List of `Races` that have access to the trait.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},subraces:{description:"List of `Subraces` that have access to the trait.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},proficiencies:{description:"List of `Proficiencies` this trait grants.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},proficiency_choices:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},language_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},trait_specific:{description:"Information specific to this trait",oneOf:[{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},{type:"object",properties:{"damage-type":{description:"A damage type associated with this trait.",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},"breath-weapon":{description:"The breath weapon action associated with a draconic ancestry.",type:"object",properties:{name:{type:"string"},desc:{type:"string"},area_of_effect:{type:"object",properties:{size:{type:"number"},type:{type:"string",enum:["sphere","cone","cylinder","line","cube"]}}},damage:{type:"object",properties:{damage_at_character_level:{type:"object",additionalProperties:{type:"string"}},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},usage:{description:"Description of the usage constraints of this action.",type:"object",properties:{times:{type:"number"},type:{type:"string"}}}}}}}]}}},example:{index:"trance",name:"Trance",url:"/api/traits/trance",desc:['Elves do not need to sleep. Instead, they meditate deeply, remaining semiconscious, for 4 hours a day. (The Common word for such meditation is "trance.") While meditating, you can dream after a fashion; such dreams are actually mental exercises that have become reflexive through years of practice. After resting this way, you gain the same benefit that a human does from 8 hours of sleep.'],proficiencies:[],races:[{index:"elf",name:"Elf",url:"/api/races/elf"}],subraces:[]}}}}},description:"Get a trait by index.",method:"get",path:"/api/traits/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a trait by index.",description:{type:"text/plain"},url:{path:["api","traits",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the `Trait` to get.",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-trait-by-index",previous:{title:"Get traits available for a subrace.",permalink:"/docs/api/get-traits-available-for-a-subrace"},next:{title:"Get a weapon property by index.",permalink:"/docs/api/get-a-weapon-property-by-index"}},d=[];function l(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-a-trait-by-index",children:"Get a trait by index."})}),"\n",(0,t.jsx)(i.p,{children:"Get a trait by index."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"artificers-lore"}),", ",(0,t.jsx)(i.code,{children:"brave"}),", ",(0,t.jsx)(i.code,{children:"breath-weapon"}),", ",(0,t.jsx)(i.code,{children:"damage-resistance"}),", ",(0,t.jsx)(i.code,{children:"darkvision"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-black"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-blue"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-brass"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-bronze"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-copper"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-gold"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-green"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-red"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-silver"}),", ",(0,t.jsx)(i.code,{children:"draconic-ancestry-white"}),", ",(0,t.jsx)(i.code,{children:"dwarven-combat-training"}),", ",(0,t.jsx)(i.code,{children:"dwarven-resilience"}),", ",(0,t.jsx)(i.code,{children:"dwarven-toughness"}),", ",(0,t.jsx)(i.code,{children:"elf-weapon-training"}),", ",(0,t.jsx)(i.code,{children:"extra-language"}),", ",(0,t.jsx)(i.code,{children:"fey-ancestry"}),", ",(0,t.jsx)(i.code,{children:"gnome-cunning"}),", ",(0,t.jsx)(i.code,{children:"halfling-nimbleness"}),", ",(0,t.jsx)(i.code,{children:"hellish-resistance"}),", ",(0,t.jsx)(i.code,{children:"high-elf-cantrip"}),", ",(0,t.jsx)(i.code,{children:"infernal-legacy"}),", ",(0,t.jsx)(i.code,{children:"keen-senses"}),", ",(0,t.jsx)(i.code,{children:"lucky"}),", ",(0,t.jsx)(i.code,{children:"menacing"}),", ",(0,t.jsx)(i.code,{children:"naturally-stealthy"}),", ",(0,t.jsx)(i.code,{children:"relentless-endurance"}),", ",(0,t.jsx)(i.code,{children:"savage-attacks"}),", ",(0,t.jsx)(i.code,{children:"skill-versatility"}),", ",(0,t.jsx)(i.code,{children:"stonecunning"}),", ",(0,t.jsx)(i.code,{children:"tinker"}),", ",(0,t.jsx)(i.code,{children:"tool-proficiency"}),", ",(0,t.jsx)(i.code,{children:"trance"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["The ",(0,t.jsx)(i.code,{children:"index"})," of the ",(0,t.jsx)(i.code,{children:"Trait"})," to get."]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"races"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["List of ",(0,t.jsx)(i.code,{children:"Races"})," that have access to the trait."]})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"subraces"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["List of ",(0,t.jsx)(i.code,{children:"Subraces"})," that have access to the trait."]})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"proficiencies"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["List of ",(0,t.jsx)(i.code,{children:"Proficiencies"})," this trait grants."]})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"proficiency_choices"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Choice"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"choose"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"from"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"language_options"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Choice"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"choose"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"from"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"trait_specific"}),(0,t.jsx)("span",{style:{opacity:"0.6"}}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Information specific to this trait"})})]})})]})]})})]})})})]})]})}function a(e){void 0===e&&(e={});const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>c,x:()=>o});var t=r(96540);const n={},s=t.createContext(n);function c(e){const i=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2d6b3abf.e384b6f4.js b/assets/js/2d6b3abf.e384b6f4.js deleted file mode 100644 index 9825b75..0000000 --- a/assets/js/2d6b3abf.e384b6f4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1297],{349:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var n=r(74848),s=r(28453);const t={},l="Get a subrace by index.",c={type:"api",id:"get-a-subrace-by-index",title:"Get a subrace by index.",description:"",slug:"/get-a-subrace-by-index",frontMatter:{},api:{description:"Subraces reflect the different varieties of a certain parent race.",tags:["Subraces"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subrace to get.\n",schema:{type:"string",enum:["high-elf","hill-dwarf","lightfoot-halfling","rock-gnome"],example:"hill-dwarf"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Subrace`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the subrace.",type:"string"},race:{description:"Parent race for the subrace.",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},ability_bonuses:{description:"Additional ability bonuses for the subrace.",type:"array",items:{type:"object",properties:{bonus:{description:"Bonus amount for this ability score.",type:"number"},ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},starting_proficiencies:{description:"Starting proficiencies for all new characters of the subrace.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},languages:{description:"Starting languages for all new characters of the subrace.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},language_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},racial_traits:{description:"List of traits that for the subrace.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"hill-dwarf",name:"Hill Dwarf",url:"/api/subraces/hill-dwarf",ability_bonuses:[{ability_score:{index:"wis",name:"WIS",url:"/api/ability-scores/wis"},bonus:1}],desc:"As a hill dwarf, you have keen senses, deep intuition, and remarkable resilience.",languages:[],race:{index:"dwarf",name:"Dwarf",url:"/api/races/dwarf"},racial_traits:[{index:"dwarven-toughness",name:"Dwarven Toughness",url:"/api/traits/dwarven-toughness"}],starting_proficiencies:[]}}}}},method:"get",path:"/api/subraces/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a subrace by index.",description:{content:"Subraces reflect the different varieties of a certain parent race.",type:"text/plain"},url:{path:["api","subraces",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subrace to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-subrace-by-index",previous:{title:"Get features of the requested spell level available to the class.",permalink:"/docs/api/get-features-of-the-requested-spell-level-available-to-the-class"},next:{title:"Get proficiences available for a subrace.",permalink:"/docs/api/get-proficiences-available-for-a-subrace"}},o=[];function d(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-subrace-by-index",children:"Get a subrace by index."})}),"\n",(0,n.jsx)(i.p,{children:"Subraces reflect the different varieties of a certain parent race."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"high-elf"}),", ",(0,n.jsx)(i.code,{children:"hill-dwarf"}),", ",(0,n.jsx)(i.code,{children:"lightfoot-halfling"}),", ",(0,n.jsx)(i.code,{children:"rock-gnome"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the subrace to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the subrace."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"race"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Parent race for the subrace."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_bonuses"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Additional ability bonuses for the subrace."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"bonus"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Bonus amount for this ability score."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_score"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_proficiencies"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Starting proficiencies for all new characters of the subrace."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"languages"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Starting languages for all new characters of the subrace."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"language_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"racial_traits"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of traits that for the subrace."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function a(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>l,x:()=>c});var n=r(96540);const s={},t=n.createContext(s);function l(e){const i=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),n.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2d6b3abf.fa71428f.js b/assets/js/2d6b3abf.fa71428f.js new file mode 100644 index 0000000..43e932a --- /dev/null +++ b/assets/js/2d6b3abf.fa71428f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1297],{349:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>c,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>o});var s=r(74848),n=r(28453);const t={},c="Get a subrace by index.",l={type:"api",id:"get-a-subrace-by-index",title:"Get a subrace by index.",description:"",slug:"/get-a-subrace-by-index",frontMatter:{},api:{description:"Subraces reflect the different varieties of a certain parent race.",tags:["Subraces"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subrace to get.\n",schema:{type:"string",enum:["high-elf","hill-dwarf","lightfoot-halfling","rock-gnome"],example:"hill-dwarf"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Subrace`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the subrace.",type:"string"},race:{description:"Parent race for the subrace.",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},ability_bonuses:{description:"Additional ability bonuses for the subrace.",type:"array",items:{type:"object",properties:{bonus:{description:"Bonus amount for this ability score.",type:"number"},ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},starting_proficiencies:{description:"Starting proficiencies for all new characters of the subrace.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},languages:{description:"Starting languages for all new characters of the subrace.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},language_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},racial_traits:{description:"List of traits that for the subrace.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"hill-dwarf",name:"Hill Dwarf",url:"/api/subraces/hill-dwarf",ability_bonuses:[{ability_score:{index:"wis",name:"WIS",url:"/api/ability-scores/wis"},bonus:1}],desc:"As a hill dwarf, you have keen senses, deep intuition, and remarkable resilience.",languages:[],race:{index:"dwarf",name:"Dwarf",url:"/api/races/dwarf"},racial_traits:[{index:"dwarven-toughness",name:"Dwarven Toughness",url:"/api/traits/dwarven-toughness"}],starting_proficiencies:[]}}}}},method:"get",path:"/api/subraces/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a subrace by index.",description:{content:"Subraces reflect the different varieties of a certain parent race.",type:"text/plain"},url:{path:["api","subraces",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subrace to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-subrace-by-index",previous:{title:"Get features of the requested spell level available to the class.",permalink:"/docs/api/get-features-of-the-requested-spell-level-available-to-the-class"},next:{title:"Get proficiences available for a subrace.",permalink:"/docs/api/get-proficiences-available-for-a-subrace"}},o=[];function a(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"get-a-subrace-by-index",children:"Get a subrace by index."})}),"\n",(0,s.jsx)(i.p,{children:"Subraces reflect the different varieties of a certain parent race."}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"Possible values:"})," [",(0,s.jsx)(i.code,{children:"high-elf"}),", ",(0,s.jsx)(i.code,{children:"hill-dwarf"}),", ",(0,s.jsx)(i.code,{children:"lightfoot-halfling"}),", ",(0,s.jsx)(i.code,{children:"rock-gnome"}),"]"]})}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(i.p,{children:["The ",(0,s.jsx)(i.code,{children:"index"})," of the subrace to get."]})})]})})})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsxs)("div",{style:{display:"flex"},children:[(0,s.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)("code",{children:"200"})}),(0,s.jsx)("div",{children:(0,s.jsx)(i.p,{children:"OK"})})]}),(0,s.jsx)("div",{children:(0,s.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Schema "}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{})]})})}),(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"desc"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Description of the subrace."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"race"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Parent race for the subrace."})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"ability_bonuses"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Additional ability bonuses for the subrace."})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"bonus"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Bonus amount for this ability score."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"ability_score"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:(0,s.jsx)(i.code,{children:"APIReference"})})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"starting_proficiencies"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Starting proficiencies for all new characters of the subrace."})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"languages"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Starting languages for all new characters of the subrace."})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"language_options"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:(0,s.jsx)(i.code,{children:"Choice"})})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"desc"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"choose"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"type"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"from"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"racial_traits"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"List of traits that for the subrace."})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>c,x:()=>l});var s=r(96540);const n={},t=s.createContext(n);function c(e){const i=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),s.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/35c21b4c.16080f63.js b/assets/js/35c21b4c.16080f63.js new file mode 100644 index 0000000..8fc044f --- /dev/null +++ b/assets/js/35c21b4c.16080f63.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4006],{24525:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>c,default:()=>d,frontMatter:()=>n,metadata:()=>a,toc:()=>l});var t=r(74848),s=r(28453);const n={},c="Get proficiences available for a subrace.",a={type:"api",id:"get-proficiences-available-for-a-subrace",title:"Get proficiences available for a subrace.",description:"",slug:"/get-proficiences-available-for-a-subrace",frontMatter:{},api:{tags:["Subraces"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subrace to get.\n",schema:{type:"string",enum:["high-elf","hill-dwarf","lightfoot-halfling","rock-gnome"],example:"hill-dwarf"}}],responses:{200:{description:"List of proficiences for the subrace.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get proficiences available for a subrace.",method:"get",path:"/api/subraces/{index}/proficiencies",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get proficiences available for a subrace.",description:{type:"text/plain"},url:{path:["api","subraces",":index","proficiencies"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subrace to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-proficiences-available-for-a-subrace",previous:{title:"Get a subrace by index.",permalink:"/docs/api/get-a-subrace-by-index"},next:{title:"Get traits available for a subrace.",permalink:"/docs/api/get-traits-available-for-a-subrace"}},l=[];function o(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-proficiences-available-for-a-subrace",children:"Get proficiences available for a subrace."})}),"\n",(0,t.jsx)(i.p,{children:"Get proficiences available for a subrace."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"high-elf"}),", ",(0,t.jsx)(i.code,{children:"hill-dwarf"}),", ",(0,t.jsx)(i.code,{children:"lightfoot-halfling"}),", ",(0,t.jsx)(i.code,{children:"rock-gnome"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["The ",(0,t.jsx)(i.code,{children:"index"})," of the subrace to get."]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"List of proficiences for the subrace."})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"count"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Total number of resources available."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"results"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>c,x:()=>a});var t=r(96540);const s={},n=t.createContext(s);function c(e){const i=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(n.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/35c21b4c.fc22265c.js b/assets/js/35c21b4c.fc22265c.js deleted file mode 100644 index fc7c880..0000000 --- a/assets/js/35c21b4c.fc22265c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4006],{24525:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>a});var t=r(74848),n=r(28453);const s={},c="Get proficiences available for a subrace.",l={type:"api",id:"get-proficiences-available-for-a-subrace",title:"Get proficiences available for a subrace.",description:"",slug:"/get-proficiences-available-for-a-subrace",frontMatter:{},api:{tags:["Subraces"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subrace to get.\n",schema:{type:"string",enum:["high-elf","hill-dwarf","lightfoot-halfling","rock-gnome"],example:"hill-dwarf"}}],responses:{200:{description:"List of proficiences for the subrace.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get proficiences available for a subrace.",method:"get",path:"/api/subraces/{index}/proficiencies",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get proficiences available for a subrace.",description:{type:"text/plain"},url:{path:["api","subraces",":index","proficiencies"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subrace to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-proficiences-available-for-a-subrace",previous:{title:"Get a subrace by index.",permalink:"/docs/api/get-a-subrace-by-index"},next:{title:"Get traits available for a subrace.",permalink:"/docs/api/get-traits-available-for-a-subrace"}},a=[];function o(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-proficiences-available-for-a-subrace",children:"Get proficiences available for a subrace."})}),"\n",(0,t.jsx)(i.p,{children:"Get proficiences available for a subrace."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"high-elf"}),", ",(0,t.jsx)(i.code,{children:"hill-dwarf"}),", ",(0,t.jsx)(i.code,{children:"lightfoot-halfling"}),", ",(0,t.jsx)(i.code,{children:"rock-gnome"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["The ",(0,t.jsx)(i.code,{children:"index"})," of the subrace to get."]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"List of proficiences for the subrace."})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"count"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Total number of resources available."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"results"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>c,x:()=>l});var t=r(96540);const n={},s=t.createContext(n);function c(e){const i=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3d50c95e.83723eeb.js b/assets/js/3d50c95e.83723eeb.js new file mode 100644 index 0000000..443a7bd --- /dev/null +++ b/assets/js/3d50c95e.83723eeb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6619],{87312:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>c,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var n=r(74848),s=r(28453);const t={},c="Get a proficiency by index.",a={type:"api",id:"get-a-proficiency-by-index",title:"Get a proficiency by index.",description:"",slug:"/get-a-proficiency-by-index",frontMatter:{},api:{description:"# Proficiency \n\nBy virtue of race, class, and background a character is proficient at using certain skills, weapons, and equipment. Characters can also gain additional proficiencies at higher levels or by multiclassing. A characters starting proficiencies are determined during character creation.\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the proficiency to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `proficiencies`.\n",schema:{type:"string",example:"medium-armor"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Proficiency`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},type:{description:"The general category of the proficiency.",type:"string"},classes:{description:"Classes that start with this proficiency.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},races:{description:"Races that start with this proficiency.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},reference:{description:"`APIReference` to the full description of the related resource.\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},example:{index:"medium-armor",name:"Medium Armor",url:"/api/proficiencies/medium-armor",type:"Armor",classes:[{index:"barbarian",name:"Barbarian",url:"/api/classes/barbarian"},{index:"cleric",name:"Cleric",url:"/api/classes/cleric"},{index:"druid",name:"Druid",url:"/api/classes/druid"},{index:"ranger",name:"Ranger",url:"/api/classes/ranger"}],races:[],reference:{index:"medium-armor",name:"Medium Armor",url:"/api/equipment-categories/medium-armor"}}}}}},method:"get",path:"/api/proficiencies/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a proficiency by index.",description:{content:"# Proficiency \n\nBy virtue of race, class, and background a character is proficient at using certain skills, weapons, and equipment. Characters can also gain additional proficiencies at higher levels or by multiclassing. A characters starting proficiencies are determined during character creation.\n",type:"text/plain"},url:{path:["api","proficiencies",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the proficiency to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `proficiencies`.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-proficiency-by-index",previous:{title:"Get monster by index.",permalink:"/docs/api/get-monster-by-index"},next:{title:"Get a race by index.",permalink:"/docs/api/get-a-race-by-index"}},o=[];function d(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-proficiency-by-index",children:"Get a proficiency by index."})}),"\n",(0,n.jsx)(i.h1,{id:"proficiency",children:"Proficiency"}),"\n",(0,n.jsx)(i.p,{children:"By virtue of race, class, and background a character is proficient at using certain skills, weapons, and equipment. Characters can also gain additional proficiencies at higher levels or by multiclassing. A characters starting proficiencies are determined during character creation."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the proficiency to get."]}),(0,n.jsxs)(i.p,{children:["Available values can be found in the ",(0,n.jsx)(i.a,{href:"#get-/api/-endpoint-",children:(0,n.jsx)(i.code,{children:"ResourceList"})})," for ",(0,n.jsx)(i.code,{children:"proficiencies"}),"."]})]})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The general category of the proficiency."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"classes"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Classes that start with this proficiency."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"races"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Races that start with this proficiency."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"reference"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.code,{children:"APIReference"})," to the full description of the related resource."]})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>c,x:()=>a});var n=r(96540);const s={},t=n.createContext(s);function c(e){const i=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3d50c95e.f0bf4021.js b/assets/js/3d50c95e.f0bf4021.js deleted file mode 100644 index 6d29646..0000000 --- a/assets/js/3d50c95e.f0bf4021.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6619],{87312:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>c,default:()=>d,frontMatter:()=>t,metadata:()=>o,toc:()=>l});var n=r(74848),s=r(28453);const t={},c="Get a proficiency by index.",o={type:"api",id:"get-a-proficiency-by-index",title:"Get a proficiency by index.",description:"",slug:"/get-a-proficiency-by-index",frontMatter:{},api:{description:"# Proficiency \n\nBy virtue of race, class, and background a character is proficient at using certain skills, weapons, and equipment. Characters can also gain additional proficiencies at higher levels or by multiclassing. A characters starting proficiencies are determined during character creation.\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the proficiency to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `proficiencies`.\n",schema:{type:"string",example:"medium-armor"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Proficiency`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},type:{description:"The general category of the proficiency.",type:"string"},classes:{description:"Classes that start with this proficiency.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},races:{description:"Races that start with this proficiency.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},reference:{description:"`APIReference` to the full description of the related resource.\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},example:{index:"medium-armor",name:"Medium Armor",url:"/api/proficiencies/medium-armor",type:"Armor",classes:[{index:"barbarian",name:"Barbarian",url:"/api/classes/barbarian"},{index:"cleric",name:"Cleric",url:"/api/classes/cleric"},{index:"druid",name:"Druid",url:"/api/classes/druid"},{index:"ranger",name:"Ranger",url:"/api/classes/ranger"}],races:[],reference:{index:"medium-armor",name:"Medium Armor",url:"/api/equipment-categories/medium-armor"}}}}}},method:"get",path:"/api/proficiencies/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a proficiency by index.",description:{content:"# Proficiency \n\nBy virtue of race, class, and background a character is proficient at using certain skills, weapons, and equipment. Characters can also gain additional proficiencies at higher levels or by multiclassing. A characters starting proficiencies are determined during character creation.\n",type:"text/plain"},url:{path:["api","proficiencies",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the proficiency to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `proficiencies`.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-proficiency-by-index",previous:{title:"Get monster by index.",permalink:"/docs/api/get-monster-by-index"},next:{title:"Get a race by index.",permalink:"/docs/api/get-a-race-by-index"}},l=[];function a(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-proficiency-by-index",children:"Get a proficiency by index."})}),"\n",(0,n.jsx)(i.h1,{id:"proficiency",children:"Proficiency"}),"\n",(0,n.jsx)(i.p,{children:"By virtue of race, class, and background a character is proficient at using certain skills, weapons, and equipment. Characters can also gain additional proficiencies at higher levels or by multiclassing. A characters starting proficiencies are determined during character creation."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the proficiency to get."]}),(0,n.jsxs)(i.p,{children:["Available values can be found in the ",(0,n.jsx)(i.a,{href:"#get-/api/-endpoint-",children:(0,n.jsx)(i.code,{children:"ResourceList"})})," for ",(0,n.jsx)(i.code,{children:"proficiencies"}),"."]})]})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The general category of the proficiency."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"classes"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Classes that start with this proficiency."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"races"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Races that start with this proficiency."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"reference"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.code,{children:"APIReference"})," to the full description of the related resource."]})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>c,x:()=>o});var n=r(96540);const s={},t=n.createContext(s);function c(e){const i=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/46aa36fa.2a347bb8.js b/assets/js/46aa36fa.2a347bb8.js deleted file mode 100644 index 0e8b7b9..0000000 --- a/assets/js/46aa36fa.2a347bb8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7243],{7280:(e,s,r)=>{r.r(s),r.d(s,{contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var i=r(74848),n=r(28453);const t={},l="Get all level resources for a subclass.",c={type:"api",id:"get-all-level-resources-for-a-subclass",title:"Get all level resources for a subclass.",description:"",slug:"/get-all-level-resources-for-a-subclass",frontMatter:{},api:{tags:["Subclasses"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subclass to get.\n",schema:{type:"string",enum:["berserker","champion","devotion","draconic","evocation","fiend","hunter","land","life","lore","open-hand","thief"],example:"fiend"}}],responses:{200:{description:"List of level resource for the subclass.",content:{"application/json":{schema:{type:"array",items:{type:"object",properties:{index:{type:"string"},url:{type:"string"},level:{type:"number"},features:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},class:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},subclass:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get all level resources for a subclass.",method:"get",path:"/api/subclasses/{index}/levels",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get all level resources for a subclass.",description:{type:"text/plain"},url:{path:["api","subclasses",":index","levels"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subclass to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-all-level-resources-for-a-subclass",previous:{title:"Get features available for a subclass.",permalink:"/docs/api/get-features-available-for-a-subclass"},next:{title:"Get level resources for a subclass and level.",permalink:"/docs/api/get-level-resources-for-a-subclass-and-level"}},o=[];function d(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"get-all-level-resources-for-a-subclass",children:"Get all level resources for a subclass."})}),"\n",(0,i.jsx)(s.p,{children:"Get all level resources for a subclass."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," [",(0,i.jsx)(s.code,{children:"berserker"}),", ",(0,i.jsx)(s.code,{children:"champion"}),", ",(0,i.jsx)(s.code,{children:"devotion"}),", ",(0,i.jsx)(s.code,{children:"draconic"}),", ",(0,i.jsx)(s.code,{children:"evocation"}),", ",(0,i.jsx)(s.code,{children:"fiend"}),", ",(0,i.jsx)(s.code,{children:"hunter"}),", ",(0,i.jsx)(s.code,{children:"land"}),", ",(0,i.jsx)(s.code,{children:"life"}),", ",(0,i.jsx)(s.code,{children:"lore"}),", ",(0,i.jsx)(s.code,{children:"open-hand"}),", ",(0,i.jsx)(s.code,{children:"thief"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"index"})," of the subclass to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"List of level resource for the subclass."})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"features"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"class"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"APIReference"})})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"subclass"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"APIReference"})})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})})]})})]})})})]})]})}function a(e){void 0===e&&(e={});const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},28453:(e,s,r)=>{r.d(s,{R:()=>l,x:()=>c});var i=r(96540);const n={},t=i.createContext(n);function l(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/46aa36fa.d0ad9f8c.js b/assets/js/46aa36fa.d0ad9f8c.js new file mode 100644 index 0000000..45fedd0 --- /dev/null +++ b/assets/js/46aa36fa.d0ad9f8c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7243],{7280:(e,s,r)=>{r.r(s),r.d(s,{contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var i=r(74848),n=r(28453);const t={},l="Get all level resources for a subclass.",c={type:"api",id:"get-all-level-resources-for-a-subclass",title:"Get all level resources for a subclass.",description:"",slug:"/get-all-level-resources-for-a-subclass",frontMatter:{},api:{tags:["Subclasses"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subclass to get.\n",schema:{type:"string",enum:["berserker","champion","devotion","draconic","evocation","fiend","hunter","land","life","lore","open-hand","thief"],example:"fiend"}}],responses:{200:{description:"List of level resource for the subclass.",content:{"application/json":{schema:{type:"array",items:{type:"object",properties:{index:{type:"string"},url:{type:"string"},level:{type:"number"},features:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},class:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},subclass:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get all level resources for a subclass.",method:"get",path:"/api/subclasses/{index}/levels",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get all level resources for a subclass.",description:{type:"text/plain"},url:{path:["api","subclasses",":index","levels"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subclass to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-all-level-resources-for-a-subclass",previous:{title:"Get features available for a subclass.",permalink:"/docs/api/get-features-available-for-a-subclass"},next:{title:"Get level resources for a subclass and level.",permalink:"/docs/api/get-level-resources-for-a-subclass-and-level"}},o=[];function d(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"get-all-level-resources-for-a-subclass",children:"Get all level resources for a subclass."})}),"\n",(0,i.jsx)(s.p,{children:"Get all level resources for a subclass."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," [",(0,i.jsx)(s.code,{children:"berserker"}),", ",(0,i.jsx)(s.code,{children:"champion"}),", ",(0,i.jsx)(s.code,{children:"devotion"}),", ",(0,i.jsx)(s.code,{children:"draconic"}),", ",(0,i.jsx)(s.code,{children:"evocation"}),", ",(0,i.jsx)(s.code,{children:"fiend"}),", ",(0,i.jsx)(s.code,{children:"hunter"}),", ",(0,i.jsx)(s.code,{children:"land"}),", ",(0,i.jsx)(s.code,{children:"life"}),", ",(0,i.jsx)(s.code,{children:"lore"}),", ",(0,i.jsx)(s.code,{children:"open-hand"}),", ",(0,i.jsx)(s.code,{children:"thief"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"index"})," of the subclass to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"List of level resource for the subclass."})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"features"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"class"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"APIReference"})})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"subclass"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"APIReference"})})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})})]})})]})})})]})]})}function a(e){void 0===e&&(e={});const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},28453:(e,s,r)=>{r.d(s,{R:()=>l,x:()=>c});var i=r(96540);const n={},t=i.createContext(n);function l(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4998527c.9f8a2148.js b/assets/js/4998527c.9f8a2148.js deleted file mode 100644 index 03ad89d..0000000 --- a/assets/js/4998527c.9f8a2148.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1378],{93135:(e,s,r)=>{r.r(s),r.d(s,{contentTitle:()=>n,default:()=>d,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var i=r(74848),l=r(28453);const t={},n="Get all level resources for a class.",c={type:"api",id:"get-all-level-resources-for-a-class",title:"Get all level resources for a class.",description:"",slug:"/get-all-level-resources-for-a-class",frontMatter:{},api:{tags:["Class Levels"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}},{name:"subclass",in:"query",required:!1,description:"Adds subclasses for class to the response",schema:{type:"string"},examples:{"single-value":{value:"berserker"},"partial-value":{value:"ber"}}}],responses:{200:{description:"OK",content:{"application/json":{schema:{type:"array",items:{description:"`ClassLevel`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},level:{description:"The number value for the current level object.",type:"number"},ability_score_bonuses:{description:"Total number of ability score bonuses gained, added from previous levels.",type:"number"},prof_bonus:{description:"Proficiency bonus for this class at the specified level.",type:"number"},features:{description:"Features automatically gained at this level.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},spellcasting:{description:"Summary of spells known at this level.",type:"object",properties:{cantrips_known:{type:"number"},spells_known:{type:"number"},spell_slots_level_1:{type:"number"},spell_slots_level_2:{type:"number"},spell_slots_level_3:{type:"number"},spell_slots_level_4:{type:"number"},spell_slots_level_5:{type:"number"},spell_slots_level_6:{type:"number"},spell_slots_level_7:{type:"number"},spell_slots_level_8:{type:"number"},spell_slots_level_9:{type:"number"}}},class_specific:{description:"Class specific information such as dice values for bard songs and number of warlock invocations.",anyOf:[{description:"Barbarian Class Specific Features",type:"object",properties:{rage_count:{type:"number"},rage_damage_bonus:{type:"number"},brutal_critical_dice:{type:"number"}}},{description:"Bard Class Specific Features",type:"object",properties:{bardic_inspiration_dice:{type:"number"},song_of_rest_die:{type:"number"},magical_secrets_max_5:{type:"number"},magical_secrets_max_7:{type:"number"},magical_secrets_max_9:{type:"number"}}},{description:"Cleric Class Specific Features",type:"object",properties:{channel_divinity_charges:{type:"number"},destroy_undead_cr:{type:"number"}}},{description:"Druid Class Specific Features",type:"object",properties:{wild_shape_max_cr:{type:"number"},wild_shape_swim:{type:"boolean"},wild_shape_fly:{type:"boolean"}}},{description:"Fighter Class Specific Features",type:"object",properties:{action_surges:{type:"number"},indomitable_uses:{type:"number"},extra_attacks:{type:"number"}}},{description:"Monk Class Specific Features",type:"object",properties:{ki_points:{type:"number"},unarmored_movement:{type:"number"},martial_arts:{type:"object",properties:{dice_count:{type:"number"},dice_value:{type:"number"}}}}},{description:"Paladin Class Specific Features",type:"object",properties:{aura_range:{type:"number"}}},{description:"Bard Ranger Specific Features",type:"object",properties:{favored_enemies:{type:"number"},favored_terrain:{type:"number"}}},{description:"Bard Rogue Specific Features",type:"object",properties:{sneak_attack:{type:"object",properties:{dice_count:{type:"number"},dice_value:{type:"number"}}}}},{description:"Bard Sorcerer Specific Features",type:"object",properties:{sorcery_points:{type:"number"},metamagic_known:{type:"number"},creating_spell_slots:{type:"array",items:{type:"object",properties:{spell_slot_level:{type:"number"},sorcery_point_cost:{type:"number"}}}}}},{description:"Bard Warlock Specific Features",type:"object",properties:{invocations_known:{type:"number"},mystic_arcanum_level_6:{type:"number"},mystic_arcanum_level_7:{type:"number"},mystic_arcanum_level_8:{type:"number"},mystic_arcanum_level_9:{type:"number"}}},{description:"Wizard Class Specific Features",type:"object",properties:{arcane_recover_levels:{type:"number"}}}]}}}}}}}},description:"Get all level resources for a class.",method:"get",path:"/api/classes/{index}/levels",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get all level resources for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","levels"],host:["{{baseUrl}}"],query:[{description:{content:"Adds subclasses for class to the response",type:"text/plain"},key:"subclass",value:""}],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-all-level-resources-for-a-class",previous:{title:"Get multiclassing resource for a class.",permalink:"/docs/api/get-multiclassing-resource-for-a-class"},next:{title:"Get level resource for a class and level.",permalink:"/docs/api/get-level-resource-for-a-class-and-level"}},o=[];function a(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"get-all-level-resources-for-a-class",children:"Get all level resources for a class."})}),"\n",(0,i.jsx)(s.p,{children:"Get all level resources for a class."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," [",(0,i.jsx)(s.code,{children:"barbarian"}),", ",(0,i.jsx)(s.code,{children:"bard"}),", ",(0,i.jsx)(s.code,{children:"cleric"}),", ",(0,i.jsx)(s.code,{children:"druid"}),", ",(0,i.jsx)(s.code,{children:"fighter"}),", ",(0,i.jsx)(s.code,{children:"monk"}),", ",(0,i.jsx)(s.code,{children:"paladin"}),", ",(0,i.jsx)(s.code,{children:"ranger"}),", ",(0,i.jsx)(s.code,{children:"rogue"}),", ",(0,i.jsx)(s.code,{children:"sorcerer"}),", ",(0,i.jsx)(s.code,{children:"warlock"}),", ",(0,i.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"subclass"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Adds subclasses for class to the response"})}),(0,i.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,i.jsx)("div",{children:(0,i.jsxs)(s.p,{children:["Example (single-value):\n",(0,i.jsx)("code",{children:"berserker"})]})}),(0,i.jsx)("div",{children:(0,i.jsxs)(s.p,{children:["Example (partial-value):\n",(0,i.jsx)("code",{children:"ber"})]})})]})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"The number value for the current level object."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"ability_score_bonuses"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Total number of ability score bonuses gained, added from previous levels."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"prof_bonus"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Proficiency bonus for this class at the specified level."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"features"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Features automatically gained at this level."})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spellcasting"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Summary of spells known at this level."})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"cantrips_known"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spells_known"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_1"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_2"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_3"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_4"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_5"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_6"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_7"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_8"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_9"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"class_specific"}),(0,i.jsx)("span",{style:{opacity:"0.6"}}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Class specific information such as dice values for bard songs and number of warlock invocations."})})]})})]})})]})})})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,l.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},28453:(e,s,r)=>{r.d(s,{R:()=>n,x:()=>c});var i=r(96540);const l={},t=i.createContext(l);function n(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:n(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4998527c.af14d31e.js b/assets/js/4998527c.af14d31e.js new file mode 100644 index 0000000..f57b2bb --- /dev/null +++ b/assets/js/4998527c.af14d31e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1378],{93135:(e,s,r)=>{r.r(s),r.d(s,{contentTitle:()=>n,default:()=>d,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var i=r(74848),l=r(28453);const t={},n="Get all level resources for a class.",c={type:"api",id:"get-all-level-resources-for-a-class",title:"Get all level resources for a class.",description:"",slug:"/get-all-level-resources-for-a-class",frontMatter:{},api:{tags:["Class Levels"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}},{name:"subclass",in:"query",required:!1,description:"Adds subclasses for class to the response",schema:{type:"string"},examples:{"single-value":{value:"berserker"},"partial-value":{value:"ber"}}}],responses:{200:{description:"OK",content:{"application/json":{schema:{type:"array",items:{description:"`ClassLevel`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},level:{description:"The number value for the current level object.",type:"number"},ability_score_bonuses:{description:"Total number of ability score bonuses gained, added from previous levels.",type:"number"},prof_bonus:{description:"Proficiency bonus for this class at the specified level.",type:"number"},features:{description:"Features automatically gained at this level.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},spellcasting:{description:"Summary of spells known at this level.",type:"object",properties:{cantrips_known:{type:"number"},spells_known:{type:"number"},spell_slots_level_1:{type:"number"},spell_slots_level_2:{type:"number"},spell_slots_level_3:{type:"number"},spell_slots_level_4:{type:"number"},spell_slots_level_5:{type:"number"},spell_slots_level_6:{type:"number"},spell_slots_level_7:{type:"number"},spell_slots_level_8:{type:"number"},spell_slots_level_9:{type:"number"}}},class_specific:{description:"Class specific information such as dice values for bard songs and number of warlock invocations.",anyOf:[{description:"Barbarian Class Specific Features",type:"object",properties:{rage_count:{type:"number"},rage_damage_bonus:{type:"number"},brutal_critical_dice:{type:"number"}}},{description:"Bard Class Specific Features",type:"object",properties:{bardic_inspiration_dice:{type:"number"},song_of_rest_die:{type:"number"},magical_secrets_max_5:{type:"number"},magical_secrets_max_7:{type:"number"},magical_secrets_max_9:{type:"number"}}},{description:"Cleric Class Specific Features",type:"object",properties:{channel_divinity_charges:{type:"number"},destroy_undead_cr:{type:"number"}}},{description:"Druid Class Specific Features",type:"object",properties:{wild_shape_max_cr:{type:"number"},wild_shape_swim:{type:"boolean"},wild_shape_fly:{type:"boolean"}}},{description:"Fighter Class Specific Features",type:"object",properties:{action_surges:{type:"number"},indomitable_uses:{type:"number"},extra_attacks:{type:"number"}}},{description:"Monk Class Specific Features",type:"object",properties:{ki_points:{type:"number"},unarmored_movement:{type:"number"},martial_arts:{type:"object",properties:{dice_count:{type:"number"},dice_value:{type:"number"}}}}},{description:"Paladin Class Specific Features",type:"object",properties:{aura_range:{type:"number"}}},{description:"Bard Ranger Specific Features",type:"object",properties:{favored_enemies:{type:"number"},favored_terrain:{type:"number"}}},{description:"Bard Rogue Specific Features",type:"object",properties:{sneak_attack:{type:"object",properties:{dice_count:{type:"number"},dice_value:{type:"number"}}}}},{description:"Bard Sorcerer Specific Features",type:"object",properties:{sorcery_points:{type:"number"},metamagic_known:{type:"number"},creating_spell_slots:{type:"array",items:{type:"object",properties:{spell_slot_level:{type:"number"},sorcery_point_cost:{type:"number"}}}}}},{description:"Bard Warlock Specific Features",type:"object",properties:{invocations_known:{type:"number"},mystic_arcanum_level_6:{type:"number"},mystic_arcanum_level_7:{type:"number"},mystic_arcanum_level_8:{type:"number"},mystic_arcanum_level_9:{type:"number"}}},{description:"Wizard Class Specific Features",type:"object",properties:{arcane_recover_levels:{type:"number"}}}]}}}}}}}},description:"Get all level resources for a class.",method:"get",path:"/api/classes/{index}/levels",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get all level resources for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","levels"],host:["{{baseUrl}}"],query:[{description:{content:"Adds subclasses for class to the response",type:"text/plain"},key:"subclass",value:""}],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-all-level-resources-for-a-class",previous:{title:"Get multiclassing resource for a class.",permalink:"/docs/api/get-multiclassing-resource-for-a-class"},next:{title:"Get level resource for a class and level.",permalink:"/docs/api/get-level-resource-for-a-class-and-level"}},o=[];function a(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"get-all-level-resources-for-a-class",children:"Get all level resources for a class."})}),"\n",(0,i.jsx)(s.p,{children:"Get all level resources for a class."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," [",(0,i.jsx)(s.code,{children:"barbarian"}),", ",(0,i.jsx)(s.code,{children:"bard"}),", ",(0,i.jsx)(s.code,{children:"cleric"}),", ",(0,i.jsx)(s.code,{children:"druid"}),", ",(0,i.jsx)(s.code,{children:"fighter"}),", ",(0,i.jsx)(s.code,{children:"monk"}),", ",(0,i.jsx)(s.code,{children:"paladin"}),", ",(0,i.jsx)(s.code,{children:"ranger"}),", ",(0,i.jsx)(s.code,{children:"rogue"}),", ",(0,i.jsx)(s.code,{children:"sorcerer"}),", ",(0,i.jsx)(s.code,{children:"warlock"}),", ",(0,i.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"subclass"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Adds subclasses for class to the response"})}),(0,i.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,i.jsx)("div",{children:(0,i.jsxs)(s.p,{children:["Example (single-value):\n",(0,i.jsx)("code",{children:"berserker"})]})}),(0,i.jsx)("div",{children:(0,i.jsxs)(s.p,{children:["Example (partial-value):\n",(0,i.jsx)("code",{children:"ber"})]})})]})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"The number value for the current level object."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"ability_score_bonuses"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Total number of ability score bonuses gained, added from previous levels."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"prof_bonus"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Proficiency bonus for this class at the specified level."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"features"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Features automatically gained at this level."})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spellcasting"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Summary of spells known at this level."})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"cantrips_known"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spells_known"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_1"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_2"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_3"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_4"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_5"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_6"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_7"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_8"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_9"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"class_specific"}),(0,i.jsx)("span",{style:{opacity:"0.6"}}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Class specific information such as dice values for bard songs and number of warlock invocations."})})]})})]})})]})})})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,l.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},28453:(e,s,r)=>{r.d(s,{R:()=>n,x:()=>c});var i=r(96540);const l={},t=i.createContext(l);function n(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:n(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4d9dc338.a9578262.js b/assets/js/4d9dc338.a9578262.js new file mode 100644 index 0000000..f482724 --- /dev/null +++ b/assets/js/4d9dc338.a9578262.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4951],{42850:(e,i,n)=>{n.r(i),n.d(i,{contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var s=n(74848),t=n(28453);const r={},a="Get a rule by index.",o={type:"api",id:"get-a-rule-by-index",title:"Get a rule by index.",description:"",slug:"/get-a-rule-by-index",frontMatter:{},api:{description:"# Rule \n\nRules are pages in the SRD that document the mechanics of Dungeons and Dragons. \nRules have descriptions which is the text directly underneath the rule heading \nin the SRD. Rules also have subsections for each heading underneath the rule in the SRD.\n",tags:["Rules"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the rule to get.\n",schema:{type:"string",enum:["adventuring","appendix","combat","equipment","spellcasting","using-ability-scores"],example:"adventuring"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Rule`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the rule.",type:"string"},subsections:{description:"List of sections for each subheading underneath the rule in the SRD.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"using-ability-scores",name:"Using Ability Scores",url:"/api/rules/using-ability-scores",desc:"# Using Ability Scores\n\nSix abilities provide a quick description of every creature's physical and mental characteristics:\n- **Strength**, measuring physical power\n- **Dexterity**, measuring agility\n- **Constitution**, measuring endurance\n- **Intelligence**, measuring reasoning and memory\n- **Wisdom**, measuring perception and insight\n- **Charisma**, measuring force of personality\n\nIs a character muscle-bound and insightful? Brilliant and charming? Nimble and hardy? Ability scores define these qualities-a creature's assets as well as weaknesses.\n\nThe three main rolls of the game-the ability check, the saving throw, and the attack roll-rely on the six ability scores. The book's introduction describes the basic rule behind these rolls: roll a d20, add an ability modifier derived from one of the six ability scores, and compare the total to a target number.\n\n**Ability Scores and Modifiers** Each of a creature's abilities has a score, a number that defines the magnitude of that ability. An ability score is not just a measure of innate capabilities, but also encompasses a creature's training and competence in activities related to that ability.\n\nA score of 10 or 11 is the normal human average, but adventurers and many monsters are a cut above average in most abilities. A score of 18 is the highest that a person usually reaches. Adventurers can have scores as high as 20, and monsters and divine beings can have scores as high as 30.\n\nEach ability also has a modifier, derived from the score and ranging from -5 (for an ability score of 1) to +10 (for a score of 30). The Ability Scores and Modifiers table notes the ability modifiers for the range of possible ability scores, from 1 to 30.\n",subsections:[{index:"ability-scores-and-modifiers",name:"Ability Scores and Modifiers",url:"/api/rule-sections/ability-scores-and-modifiers"},{index:"advantage-and-disadvantage",name:"Advantage and Disadvantage",url:"/api/rule-sections/advantage-and-disadvantage"},{index:"proficiency-bonus",name:"Proficiency Bonus",url:"/api/rule-sections/proficiency-bonus"},{index:"ability-checks",name:"Ability Checks",url:"/api/rule-sections/ability-checks"},{index:"using-each-ability",name:"Using Each Ability",url:"/api/rule-sections/using-each-ability"},{index:"saving-throws",name:"Saving Throws",url:"/api/rule-sections/saving-throws"}]}}}}},method:"get",path:"/api/rules/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a rule by index.",description:{content:"# Rule \n\nRules are pages in the SRD that document the mechanics of Dungeons and Dragons. \nRules have descriptions which is the text directly underneath the rule heading \nin the SRD. Rules also have subsections for each heading underneath the rule in the SRD.\n",type:"text/plain"},url:{path:["api","rules",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the rule to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-rule-by-index",previous:{title:"Get a rule section by index.",permalink:"/docs/api/get-a-rule-section-by-index"},next:{title:"Get a skill by index.",permalink:"/docs/api/get-a-skill-by-index"}},l=[];function c(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"get-a-rule-by-index",children:"Get a rule by index."})}),"\n",(0,s.jsx)(i.h1,{id:"rule",children:"Rule"}),"\n",(0,s.jsx)(i.p,{children:"Rules are pages in the SRD that document the mechanics of Dungeons and Dragons.\nRules have descriptions which is the text directly underneath the rule heading\nin the SRD. Rules also have subsections for each heading underneath the rule in the SRD."}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"Possible values:"})," [",(0,s.jsx)(i.code,{children:"adventuring"}),", ",(0,s.jsx)(i.code,{children:"appendix"}),", ",(0,s.jsx)(i.code,{children:"combat"}),", ",(0,s.jsx)(i.code,{children:"equipment"}),", ",(0,s.jsx)(i.code,{children:"spellcasting"}),", ",(0,s.jsx)(i.code,{children:"using-ability-scores"}),"]"]})}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(i.p,{children:["The ",(0,s.jsx)(i.code,{children:"index"})," of the rule to get."]})})]})})})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsxs)("div",{style:{display:"flex"},children:[(0,s.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)("code",{children:"200"})}),(0,s.jsx)("div",{children:(0,s.jsx)(i.p,{children:"OK"})})]}),(0,s.jsx)("div",{children:(0,s.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Schema "}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{})]})})}),(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"desc"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Description of the rule."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"subsections"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"List of sections for each subheading underneath the rule in the SRD."})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},28453:(e,i,n)=>{n.d(i,{R:()=>a,x:()=>o});var s=n(96540);const t={},r=s.createContext(t);function a(e){const i=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),s.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4d9dc338.fbd874db.js b/assets/js/4d9dc338.fbd874db.js deleted file mode 100644 index f653b0d..0000000 --- a/assets/js/4d9dc338.fbd874db.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4951],{42850:(e,i,n)=>{n.r(i),n.d(i,{contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var s=n(74848),t=n(28453);const r={},a="Get a rule by index.",l={type:"api",id:"get-a-rule-by-index",title:"Get a rule by index.",description:"",slug:"/get-a-rule-by-index",frontMatter:{},api:{description:"# Rule \n\nRules are pages in the SRD that document the mechanics of Dungeons and Dragons. \nRules have descriptions which is the text directly underneath the rule heading \nin the SRD. Rules also have subsections for each heading underneath the rule in the SRD.\n",tags:["Rules"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the rule to get.\n",schema:{type:"string",enum:["adventuring","appendix","combat","equipment","spellcasting","using-ability-scores"],example:"adventuring"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Rule`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the rule.",type:"string"},subsections:{description:"List of sections for each subheading underneath the rule in the SRD.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"using-ability-scores",name:"Using Ability Scores",url:"/api/rules/using-ability-scores",desc:"# Using Ability Scores\n\nSix abilities provide a quick description of every creature's physical and mental characteristics:\n- **Strength**, measuring physical power\n- **Dexterity**, measuring agility\n- **Constitution**, measuring endurance\n- **Intelligence**, measuring reasoning and memory\n- **Wisdom**, measuring perception and insight\n- **Charisma**, measuring force of personality\n\nIs a character muscle-bound and insightful? Brilliant and charming? Nimble and hardy? Ability scores define these qualities-a creature's assets as well as weaknesses.\n\nThe three main rolls of the game-the ability check, the saving throw, and the attack roll-rely on the six ability scores. The book's introduction describes the basic rule behind these rolls: roll a d20, add an ability modifier derived from one of the six ability scores, and compare the total to a target number.\n\n**Ability Scores and Modifiers** Each of a creature's abilities has a score, a number that defines the magnitude of that ability. An ability score is not just a measure of innate capabilities, but also encompasses a creature's training and competence in activities related to that ability.\n\nA score of 10 or 11 is the normal human average, but adventurers and many monsters are a cut above average in most abilities. A score of 18 is the highest that a person usually reaches. Adventurers can have scores as high as 20, and monsters and divine beings can have scores as high as 30.\n\nEach ability also has a modifier, derived from the score and ranging from -5 (for an ability score of 1) to +10 (for a score of 30). The Ability Scores and Modifiers table notes the ability modifiers for the range of possible ability scores, from 1 to 30.\n",subsections:[{index:"ability-scores-and-modifiers",name:"Ability Scores and Modifiers",url:"/api/rule-sections/ability-scores-and-modifiers"},{index:"advantage-and-disadvantage",name:"Advantage and Disadvantage",url:"/api/rule-sections/advantage-and-disadvantage"},{index:"proficiency-bonus",name:"Proficiency Bonus",url:"/api/rule-sections/proficiency-bonus"},{index:"ability-checks",name:"Ability Checks",url:"/api/rule-sections/ability-checks"},{index:"using-each-ability",name:"Using Each Ability",url:"/api/rule-sections/using-each-ability"},{index:"saving-throws",name:"Saving Throws",url:"/api/rule-sections/saving-throws"}]}}}}},method:"get",path:"/api/rules/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a rule by index.",description:{content:"# Rule \n\nRules are pages in the SRD that document the mechanics of Dungeons and Dragons. \nRules have descriptions which is the text directly underneath the rule heading \nin the SRD. Rules also have subsections for each heading underneath the rule in the SRD.\n",type:"text/plain"},url:{path:["api","rules",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the rule to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-rule-by-index",previous:{title:"Get a rule section by index.",permalink:"/docs/api/get-a-rule-section-by-index"},next:{title:"Get a skill by index.",permalink:"/docs/api/get-a-skill-by-index"}},o=[];function c(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"get-a-rule-by-index",children:"Get a rule by index."})}),"\n",(0,s.jsx)(i.h1,{id:"rule",children:"Rule"}),"\n",(0,s.jsx)(i.p,{children:"Rules are pages in the SRD that document the mechanics of Dungeons and Dragons.\nRules have descriptions which is the text directly underneath the rule heading\nin the SRD. Rules also have subsections for each heading underneath the rule in the SRD."}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"Possible values:"})," [",(0,s.jsx)(i.code,{children:"adventuring"}),", ",(0,s.jsx)(i.code,{children:"appendix"}),", ",(0,s.jsx)(i.code,{children:"combat"}),", ",(0,s.jsx)(i.code,{children:"equipment"}),", ",(0,s.jsx)(i.code,{children:"spellcasting"}),", ",(0,s.jsx)(i.code,{children:"using-ability-scores"}),"]"]})}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(i.p,{children:["The ",(0,s.jsx)(i.code,{children:"index"})," of the rule to get."]})})]})})})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsxs)("div",{style:{display:"flex"},children:[(0,s.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)("code",{children:"200"})}),(0,s.jsx)("div",{children:(0,s.jsx)(i.p,{children:"OK"})})]}),(0,s.jsx)("div",{children:(0,s.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Schema "}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{})]})})}),(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"level"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"desc"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Description of the rule."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"subsections"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"List of sections for each subheading underneath the rule in the SRD."})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"level"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},28453:(e,i,n)=>{n.d(i,{R:()=>a,x:()=>l});var s=n(96540);const t={},r=s.createContext(t);function a(e){const i=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),s.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4def2e36.50a24d08.js b/assets/js/4def2e36.50a24d08.js new file mode 100644 index 0000000..6b75a1a --- /dev/null +++ b/assets/js/4def2e36.50a24d08.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2178],{61681:(e,i,t)=>{t.r(i),t.d(i,{contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var n=t(74848),s=t(28453);const r={},a="Get an ability score by index.",l={type:"api",id:"get-an-ability-score-by-index",title:"Get an ability score by index.",description:"",slug:"/get-an-ability-score-by-index",frontMatter:{},api:{description:"# Ability Score\n\nRepresents one of the six abilities that describes a creature's physical and mental characteristics. The three main rolls of the game - the ability check, the saving throw, and the attack roll - rely on the ability scores. [[SRD p76](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=76)]\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the ability score to get.\n",schema:{type:"string",enum:["cha","con","dex","int","str","wis"],example:"cha"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`AbilityScore`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},full_name:{description:"Full name of the ability score.",type:"string"},skills:{description:"List of skills that use this ability score.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"cha",name:"CHA",url:"/api/ability-scores/cha",desc:["Charisma measures your ability to interact effectively with others. It includes such factors as confidence and eloquence, and it can represent a charming or commanding personality.","A Charisma check might arise when you try to influence or entertain others, when you try to make an impression or tell a convincing lie, or when you are navigating a tricky social situation. The Deception, Intimidation, Performance, and Persuasion skills reflect aptitude in certain kinds of Charisma checks."],full_name:"Charisma",skills:[{index:"deception",name:"Deception",url:"/api/skills/deception"},{index:"intimidation",name:"Intimidation",url:"/api/skills/intimidation"},{index:"performance",name:"Performance",url:"/api/skills/performance"},{index:"persuasion",name:"Persuasion",url:"/api/skills/persuasion"}]}}}}},method:"get",path:"/api/ability-scores/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get an ability score by index.",description:{content:"# Ability Score\n\nRepresents one of the six abilities that describes a creature's physical and mental characteristics. The three main rolls of the game - the ability check, the saving throw, and the attack roll - rely on the ability scores. [[SRD p76](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=76)]\n",type:"text/plain"},url:{path:["api","ability-scores",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the ability score to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-an-ability-score-by-index",previous:{title:"Get list of all available resources for an endpoint.",permalink:"/docs/api/get-list-of-all-available-resources-for-an-endpoint"},next:{title:"Get an alignment by index.",permalink:"/docs/api/get-an-alignment-by-index"}},o=[];function c(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-an-ability-score-by-index",children:"Get an ability score by index."})}),"\n",(0,n.jsx)(i.h1,{id:"ability-score",children:"Ability Score"}),"\n",(0,n.jsxs)(i.p,{children:["Represents one of the six abilities that describes a creature's physical and mental characteristics. The three main rolls of the game - the ability check, the saving throw, and the attack roll - rely on the ability scores. [",(0,n.jsx)(i.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=76",children:"SRD p76"}),"]"]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"cha"}),", ",(0,n.jsx)(i.code,{children:"con"}),", ",(0,n.jsx)(i.code,{children:"dex"}),", ",(0,n.jsx)(i.code,{children:"int"}),", ",(0,n.jsx)(i.code,{children:"str"}),", ",(0,n.jsx)(i.code,{children:"wis"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the ability score to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"full_name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Full name of the ability score."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"skills"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of skills that use this ability score."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>a,x:()=>l});var n=t(96540);const s={},r=n.createContext(s);function a(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4def2e36.c5f69987.js b/assets/js/4def2e36.c5f69987.js deleted file mode 100644 index 4bdf4b4..0000000 --- a/assets/js/4def2e36.c5f69987.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2178],{61681:(e,i,t)=>{t.r(i),t.d(i,{contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var n=t(74848),s=t(28453);const r={},l="Get an ability score by index.",a={type:"api",id:"get-an-ability-score-by-index",title:"Get an ability score by index.",description:"",slug:"/get-an-ability-score-by-index",frontMatter:{},api:{description:"# Ability Score\n\nRepresents one of the six abilities that describes a creature's physical and mental characteristics. The three main rolls of the game - the ability check, the saving throw, and the attack roll - rely on the ability scores. [[SRD p76](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=76)]\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the ability score to get.\n",schema:{type:"string",enum:["cha","con","dex","int","str","wis"],example:"cha"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`AbilityScore`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},full_name:{description:"Full name of the ability score.",type:"string"},skills:{description:"List of skills that use this ability score.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"cha",name:"CHA",url:"/api/ability-scores/cha",desc:["Charisma measures your ability to interact effectively with others. It includes such factors as confidence and eloquence, and it can represent a charming or commanding personality.","A Charisma check might arise when you try to influence or entertain others, when you try to make an impression or tell a convincing lie, or when you are navigating a tricky social situation. The Deception, Intimidation, Performance, and Persuasion skills reflect aptitude in certain kinds of Charisma checks."],full_name:"Charisma",skills:[{index:"deception",name:"Deception",url:"/api/skills/deception"},{index:"intimidation",name:"Intimidation",url:"/api/skills/intimidation"},{index:"performance",name:"Performance",url:"/api/skills/performance"},{index:"persuasion",name:"Persuasion",url:"/api/skills/persuasion"}]}}}}},method:"get",path:"/api/ability-scores/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get an ability score by index.",description:{content:"# Ability Score\n\nRepresents one of the six abilities that describes a creature's physical and mental characteristics. The three main rolls of the game - the ability check, the saving throw, and the attack roll - rely on the ability scores. [[SRD p76](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=76)]\n",type:"text/plain"},url:{path:["api","ability-scores",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the ability score to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-an-ability-score-by-index",previous:{title:"Get list of all available resources for an endpoint.",permalink:"/docs/api/get-list-of-all-available-resources-for-an-endpoint"},next:{title:"Get an alignment by index.",permalink:"/docs/api/get-an-alignment-by-index"}},o=[];function c(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-an-ability-score-by-index",children:"Get an ability score by index."})}),"\n",(0,n.jsx)(i.h1,{id:"ability-score",children:"Ability Score"}),"\n",(0,n.jsxs)(i.p,{children:["Represents one of the six abilities that describes a creature's physical and mental characteristics. The three main rolls of the game - the ability check, the saving throw, and the attack roll - rely on the ability scores. [",(0,n.jsx)(i.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=76",children:"SRD p76"}),"]"]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"cha"}),", ",(0,n.jsx)(i.code,{children:"con"}),", ",(0,n.jsx)(i.code,{children:"dex"}),", ",(0,n.jsx)(i.code,{children:"int"}),", ",(0,n.jsx)(i.code,{children:"str"}),", ",(0,n.jsx)(i.code,{children:"wis"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the ability score to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"full_name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Full name of the ability score."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"skills"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of skills that use this ability score."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>l,x:()=>a});var n=t(96540);const s={},r=n.createContext(s);function l(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/61cee229.6c87e655.js b/assets/js/61cee229.6c87e655.js new file mode 100644 index 0000000..2faeb7a --- /dev/null +++ b/assets/js/61cee229.6c87e655.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3138],{69355:(e,i,l)=>{l.r(i),l.d(i,{contentTitle:()=>r,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>c});var t=l(74848),s=l(28453);const n={},r="Get list of spells with optional filtering.",o={type:"api",id:"get-list-of-spells-with-optional-filtering",title:"Get list of spells with optional filtering.",description:"",slug:"/get-list-of-spells-with-optional-filtering",frontMatter:{},api:{tags:["Spells"],parameters:[{name:"level",in:"query",required:!1,description:"The level or levels to filter on.",schema:{type:"array",items:{type:"integer"}},examples:{"single-value":{value:[1]},"multiple-value":{value:[1,2]}}},{name:"school",in:"query",required:!1,description:"The magic school or schools to filter on.",schema:{type:"array",items:{type:"string"}},examples:{"single-value":{value:["illusion"]},"multiple-value":{value:["evocation","illusion"]},"partial-value":{value:["illu"]}}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get list of spells with optional filtering.",method:"get",path:"/api/spells",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get list of spells with optional filtering.",description:{type:"text/plain"},url:{path:["api","spells"],host:["{{baseUrl}}"],query:[{description:{content:"The level or levels to filter on.",type:"text/plain"},key:"level",value:""},{description:{content:"The level or levels to filter on.",type:"text/plain"},key:"level",value:""},{description:{content:"The magic school or schools to filter on.",type:"text/plain"},key:"school",value:""},{description:{content:"The magic school or schools to filter on.",type:"text/plain"},key:"school",value:""}],variable:[]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-list-of-spells-with-optional-filtering",previous:{title:"Get a skill by index.",permalink:"/docs/api/get-a-skill-by-index"},next:{title:"Get a spell by index.",permalink:"/docs/api/get-a-spell-by-index"}},c=[];function a(e){const i={h1:"h1",header:"header",p:"p",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-list-of-spells-with-optional-filtering",children:"Get list of spells with optional filtering."})}),"\n",(0,t.jsx)(i.p,{children:"Get list of spells with optional filtering."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer[]"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The level or levels to filter on."})}),(0,t.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,t.jsx)("div",{children:(0,t.jsxs)(i.p,{children:["Example (single-value):\n",(0,t.jsx)("code",{children:"1"})]})}),(0,t.jsx)("div",{children:(0,t.jsxs)(i.p,{children:["Example (multiple-value):\n",(0,t.jsx)("code",{children:"1,2"})]})})]})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"school"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The magic school or schools to filter on."})}),(0,t.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,t.jsx)("div",{children:(0,t.jsxs)(i.p,{children:["Example (single-value):\n",(0,t.jsx)("code",{children:"illusion"})]})}),(0,t.jsx)("div",{children:(0,t.jsxs)(i.p,{children:["Example (multiple-value):\n",(0,t.jsx)("code",{children:"evocation,illusion"})]})}),(0,t.jsx)("div",{children:(0,t.jsxs)(i.p,{children:["Example (partial-value):\n",(0,t.jsx)("code",{children:"illu"})]})})]})]})})]})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"count"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Total number of resources available."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"results"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},28453:(e,i,l)=>{l.d(i,{R:()=>r,x:()=>o});var t=l(96540);const s={},n=t.createContext(s);function r(e){const i=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(n.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/61cee229.dc2f06d4.js b/assets/js/61cee229.dc2f06d4.js deleted file mode 100644 index dce194a..0000000 --- a/assets/js/61cee229.dc2f06d4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3138],{69355:(e,i,l)=>{l.r(i),l.d(i,{contentTitle:()=>r,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>c});var t=l(74848),s=l(28453);const n={},r="Get list of spells with optional filtering.",o={type:"api",id:"get-list-of-spells-with-optional-filtering",title:"Get list of spells with optional filtering.",description:"",slug:"/get-list-of-spells-with-optional-filtering",frontMatter:{},api:{tags:["Spells"],parameters:[{name:"level",in:"query",required:!1,description:"The level or levels to filter on.",schema:{type:"array",items:{type:"integer"}},examples:{"single-value":{value:[1]},"multiple-value":{value:[1,2]}}},{name:"school",in:"query",required:!1,description:"The magic school or schools to filter on.",schema:{type:"array",items:{type:"string"}},examples:{"single-value":{value:["illusion"]},"multiple-value":{value:["evocation","illusion"]},"partial-value":{value:["illu"]}}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get list of spells with optional filtering.",method:"get",path:"/api/spells",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get list of spells with optional filtering.",description:{type:"text/plain"},url:{path:["api","spells"],host:["{{baseUrl}}"],query:[{description:{content:"The level or levels to filter on.",type:"text/plain"},key:"level",value:""},{description:{content:"The level or levels to filter on.",type:"text/plain"},key:"level",value:""},{description:{content:"The magic school or schools to filter on.",type:"text/plain"},key:"school",value:""},{description:{content:"The magic school or schools to filter on.",type:"text/plain"},key:"school",value:""}],variable:[]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-list-of-spells-with-optional-filtering",previous:{title:"Get a skill by index.",permalink:"/docs/api/get-a-skill-by-index"},next:{title:"Get a spell by index.",permalink:"/docs/api/get-a-spell-by-index"}},c=[];function a(e){const i={h1:"h1",header:"header",p:"p",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-list-of-spells-with-optional-filtering",children:"Get list of spells with optional filtering."})}),"\n",(0,t.jsx)(i.p,{children:"Get list of spells with optional filtering."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer[]"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The level or levels to filter on."})}),(0,t.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,t.jsx)("div",{children:(0,t.jsxs)(i.p,{children:["Example (single-value):\n",(0,t.jsx)("code",{children:"1"})]})}),(0,t.jsx)("div",{children:(0,t.jsxs)(i.p,{children:["Example (multiple-value):\n",(0,t.jsx)("code",{children:"1,2"})]})})]})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"school"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The magic school or schools to filter on."})}),(0,t.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,t.jsx)("div",{children:(0,t.jsxs)(i.p,{children:["Example (single-value):\n",(0,t.jsx)("code",{children:"illusion"})]})}),(0,t.jsx)("div",{children:(0,t.jsxs)(i.p,{children:["Example (multiple-value):\n",(0,t.jsx)("code",{children:"evocation,illusion"})]})}),(0,t.jsx)("div",{children:(0,t.jsxs)(i.p,{children:["Example (partial-value):\n",(0,t.jsx)("code",{children:"illu"})]})})]})]})})]})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"count"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Total number of resources available."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"results"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},28453:(e,i,l)=>{l.d(i,{R:()=>r,x:()=>o});var t=l(96540);const s={},n=t.createContext(s);function r(e){const i=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(n.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/71c3de18.632ebf44.js b/assets/js/71c3de18.632ebf44.js deleted file mode 100644 index 3c10847..0000000 --- a/assets/js/71c3de18.632ebf44.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2627],{95411:(e,n,t)=>{t.r(n),t.d(n,{contentTitle:()=>d,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var i=t(74848),s=t(28453);const r={},d="Get a damage type by index.",a={type:"api",id:"get-a-damage-type-by-index",title:"Get a damage type by index.",description:"",slug:"/get-a-damage-type-by-index",frontMatter:{},api:{description:"# Damage type\n\nDifferent attacks, damaging spells, and other harmful effects deal different \ntypes of damage. Damage types have no rules of their own, but other rules, \nsuch as damage resistance, rely on the types.\n",tags:["Game Mechanics"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the damage type to get.\n",schema:{type:"string",enum:["acid","bludgeoning","cold","fire","force","lightning","necrotic","piercing","poison","psychic","radiant","slashing","thunder"],example:"acid"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`DamageType`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}}}},example:{index:"acid",name:"Acid",url:"/api/damage-types/acid",desc:["The corrosive spray of a black dragon's breath and the dissolving enzymes secreted by a black pudding deal acid damage."]}}}}},method:"get",path:"/api/damage-types/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a damage type by index.",description:{content:"# Damage type\n\nDifferent attacks, damaging spells, and other harmful effects deal different \ntypes of damage. Damage types have no rules of their own, but other rules, \nsuch as damage resistance, rely on the types.\n",type:"text/plain"},url:{path:["api","damage-types",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the damage type to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-damage-type-by-index",previous:{title:"Get a condition by index.",permalink:"/docs/api/get-a-condition-by-index"},next:{title:"Get an equipment item by index.",permalink:"/docs/api/get-an-equipment-item-by-index"}},c=[];function o(e){const n={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"get-a-damage-type-by-index",children:"Get a damage type by index."})}),"\n",(0,i.jsx)(n.h1,{id:"damage-type",children:"Damage type"}),"\n",(0,i.jsx)(n.p,{children:"Different attacks, damaging spells, and other harmful effects deal different\ntypes of damage. Damage types have no rules of their own, but other rules,\nsuch as damage resistance, rely on the types."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Possible values:"})," [",(0,i.jsx)(n.code,{children:"acid"}),", ",(0,i.jsx)(n.code,{children:"bludgeoning"}),", ",(0,i.jsx)(n.code,{children:"cold"}),", ",(0,i.jsx)(n.code,{children:"fire"}),", ",(0,i.jsx)(n.code,{children:"force"}),", ",(0,i.jsx)(n.code,{children:"lightning"}),", ",(0,i.jsx)(n.code,{children:"necrotic"}),", ",(0,i.jsx)(n.code,{children:"piercing"}),", ",(0,i.jsx)(n.code,{children:"poison"}),", ",(0,i.jsx)(n.code,{children:"psychic"}),", ",(0,i.jsx)(n.code,{children:"radiant"}),", ",(0,i.jsx)(n.code,{children:"slashing"}),", ",(0,i.jsx)(n.code,{children:"thunder"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"index"})," of the damage type to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Level of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"desc"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Description of the resource."})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>d,x:()=>a});var i=t(96540);const s={},r=i.createContext(s);function d(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/71c3de18.c3985694.js b/assets/js/71c3de18.c3985694.js new file mode 100644 index 0000000..38d494d --- /dev/null +++ b/assets/js/71c3de18.c3985694.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2627],{95411:(e,n,t)=>{t.r(n),t.d(n,{contentTitle:()=>d,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var i=t(74848),s=t(28453);const r={},d="Get a damage type by index.",a={type:"api",id:"get-a-damage-type-by-index",title:"Get a damage type by index.",description:"",slug:"/get-a-damage-type-by-index",frontMatter:{},api:{description:"# Damage type\n\nDifferent attacks, damaging spells, and other harmful effects deal different \ntypes of damage. Damage types have no rules of their own, but other rules, \nsuch as damage resistance, rely on the types.\n",tags:["Game Mechanics"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the damage type to get.\n",schema:{type:"string",enum:["acid","bludgeoning","cold","fire","force","lightning","necrotic","piercing","poison","psychic","radiant","slashing","thunder"],example:"acid"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`DamageType`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}}}},example:{index:"acid",name:"Acid",url:"/api/damage-types/acid",desc:["The corrosive spray of a black dragon's breath and the dissolving enzymes secreted by a black pudding deal acid damage."]}}}}},method:"get",path:"/api/damage-types/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a damage type by index.",description:{content:"# Damage type\n\nDifferent attacks, damaging spells, and other harmful effects deal different \ntypes of damage. Damage types have no rules of their own, but other rules, \nsuch as damage resistance, rely on the types.\n",type:"text/plain"},url:{path:["api","damage-types",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the damage type to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-damage-type-by-index",previous:{title:"Get a condition by index.",permalink:"/docs/api/get-a-condition-by-index"},next:{title:"Get an equipment item by index.",permalink:"/docs/api/get-an-equipment-item-by-index"}},c=[];function o(e){const n={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"get-a-damage-type-by-index",children:"Get a damage type by index."})}),"\n",(0,i.jsx)(n.h1,{id:"damage-type",children:"Damage type"}),"\n",(0,i.jsx)(n.p,{children:"Different attacks, damaging spells, and other harmful effects deal different\ntypes of damage. Damage types have no rules of their own, but other rules,\nsuch as damage resistance, rely on the types."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Possible values:"})," [",(0,i.jsx)(n.code,{children:"acid"}),", ",(0,i.jsx)(n.code,{children:"bludgeoning"}),", ",(0,i.jsx)(n.code,{children:"cold"}),", ",(0,i.jsx)(n.code,{children:"fire"}),", ",(0,i.jsx)(n.code,{children:"force"}),", ",(0,i.jsx)(n.code,{children:"lightning"}),", ",(0,i.jsx)(n.code,{children:"necrotic"}),", ",(0,i.jsx)(n.code,{children:"piercing"}),", ",(0,i.jsx)(n.code,{children:"poison"}),", ",(0,i.jsx)(n.code,{children:"psychic"}),", ",(0,i.jsx)(n.code,{children:"radiant"}),", ",(0,i.jsx)(n.code,{children:"slashing"}),", ",(0,i.jsx)(n.code,{children:"thunder"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"index"})," of the damage type to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"desc"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Description of the resource."})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>d,x:()=>a});var i=t(96540);const s={},r=i.createContext(s);function d(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/75a4143c.45a0e1e0.js b/assets/js/75a4143c.45a0e1e0.js new file mode 100644 index 0000000..1e538e4 --- /dev/null +++ b/assets/js/75a4143c.45a0e1e0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9117],{61045:(e,i,n)=>{n.r(i),n.d(i,{contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var t=n(74848),r=n(28453);const s={},a="Get a magic item by index.",o={type:"api",id:"get-a-magic-item-by-index",title:"Get a magic item by index.",description:"",slug:"/get-a-magic-item-by-index",frontMatter:{},api:{description:"These are the various magic items you can find in the game.",tags:["Equipment"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the magic item to get.\n\nAvailable values can be found in the resource list for this endpoint.\n",schema:{type:"string"},example:"adamantine-armor"}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`MagicItem`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},image:{description:"The image url of the magic item.",type:"string"},equipment_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},rarity:{type:"object",properties:{name:{description:"The rarity of the item.",type:"string",enum:["Varies","Common","Uncommon","Rare","Very Rare","Legendary","Artifact"]}}},variants:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},variant:{description:"Whether this is a variant or not",type:"boolean"}}},example:{index:"adamantine-armor",name:"Adamantine Armor",url:"/api/magic-items/adamantine-armor",desc:["Armor (medium or heavy, but not hide), uncommon","This suit of armor is reinforced with adamantine, one of the hardest substances in existence. While you're wearing it, any critical hit against you becomes a normal hit."],equipment_category:{index:"armor",name:"Armor",url:"/api/equipment-categories/armor"},rarity:{name:"Uncommon"},variants:[],variant:!1}}}}},method:"get",path:"/api/magic-items/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a magic item by index.",description:{content:"These are the various magic items you can find in the game.",type:"text/plain"},url:{path:["api","magic-items",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the magic item to get.\n\nAvailable values can be found in the resource list for this endpoint.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-magic-item-by-index",previous:{title:"Get a language by index.",permalink:"/docs/api/get-a-language-by-index"},next:{title:"Get a magic school by index.",permalink:"/docs/api/get-a-magic-school-by-index"}},c=[];function d(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-a-magic-item-by-index",children:"Get a magic item by index."})}),"\n",(0,t.jsx)(i.p,{children:"These are the various magic items you can find in the game."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,t.jsxs)(i.p,{children:["The ",(0,t.jsx)(i.code,{children:"index"})," of the magic item to get."]}),(0,t.jsx)(i.p,{children:"Available values can be found in the resource list for this endpoint."})]}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["Example:\n",(0,t.jsx)("code",{children:"adamantine-armor"})]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"image"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The image url of the magic item."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"equipment_category"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"rarity"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"Varies"}),", ",(0,t.jsx)(i.code,{children:"Common"}),", ",(0,t.jsx)(i.code,{children:"Uncommon"}),", ",(0,t.jsx)(i.code,{children:"Rare"}),", ",(0,t.jsx)(i.code,{children:"Very Rare"}),", ",(0,t.jsx)(i.code,{children:"Legendary"}),", ",(0,t.jsx)(i.code,{children:"Artifact"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The rarity of the item."})})]})})})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"variants"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"variant"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" boolean"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Whether this is a variant or not"})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},28453:(e,i,n)=>{n.d(i,{R:()=>a,x:()=>o});var t=n(96540);const r={},s=t.createContext(r);function a(e){const i=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/75a4143c.92f2044a.js b/assets/js/75a4143c.92f2044a.js deleted file mode 100644 index c6453f5..0000000 --- a/assets/js/75a4143c.92f2044a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9117],{61045:(e,i,n)=>{n.r(i),n.d(i,{contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var r=n(74848),t=n(28453);const s={},o="Get a magic item by index.",c={type:"api",id:"get-a-magic-item-by-index",title:"Get a magic item by index.",description:"",slug:"/get-a-magic-item-by-index",frontMatter:{},api:{description:"These are the various magic items you can find in the game.",tags:["Equipment"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the magic item to get.\n\nAvailable values can be found in the resource list for this endpoint.\n",schema:{type:"string"},example:"adamantine-armor"}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`MagicItem`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},equipment_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},rarity:{type:"object",properties:{name:{description:"The rarity of the item.",type:"string",enum:["Varies","Common","Uncommon","Rare","Very Rare","Legendary","Artifact"]}}},variants:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},variant:{description:"Whether this is a variant or not",type:"boolean"}}},example:{index:"adamantine-armor",name:"Adamantine Armor",url:"/api/magic-items/adamantine-armor",desc:["Armor (medium or heavy, but not hide), uncommon","This suit of armor is reinforced with adamantine, one of the hardest substances in existence. While you're wearing it, any critical hit against you becomes a normal hit."],equipment_category:{index:"armor",name:"Armor",url:"/api/equipment-categories/armor"},rarity:{name:"Uncommon"},variants:[],variant:!1}}}}},method:"get",path:"/api/magic-items/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a magic item by index.",description:{content:"These are the various magic items you can find in the game.",type:"text/plain"},url:{path:["api","magic-items",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the magic item to get.\n\nAvailable values can be found in the resource list for this endpoint.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-magic-item-by-index",previous:{title:"Get a language by index.",permalink:"/docs/api/get-a-language-by-index"},next:{title:"Get a magic school by index.",permalink:"/docs/api/get-a-magic-school-by-index"}},a=[];function l(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"get-a-magic-item-by-index",children:"Get a magic item by index."})}),"\n",(0,r.jsx)(i.p,{children:"These are the various magic items you can find in the game."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,r.jsxs)(i.p,{children:["The ",(0,r.jsx)(i.code,{children:"index"})," of the magic item to get."]}),(0,r.jsx)(i.p,{children:"Available values can be found in the resource list for this endpoint."})]}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:["Example:\n",(0,r.jsx)("code",{children:"adamantine-armor"})]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(i.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"equipment_category"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:(0,r.jsx)(i.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"rarity"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"Possible values:"})," [",(0,r.jsx)(i.code,{children:"Varies"}),", ",(0,r.jsx)(i.code,{children:"Common"}),", ",(0,r.jsx)(i.code,{children:"Uncommon"}),", ",(0,r.jsx)(i.code,{children:"Rare"}),", ",(0,r.jsx)(i.code,{children:"Very Rare"}),", ",(0,r.jsx)(i.code,{children:"Legendary"}),", ",(0,r.jsx)(i.code,{children:"Artifact"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"The rarity of the item."})})]})})})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"variants"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"variant"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" boolean"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Whether this is a variant or not"})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},28453:(e,i,n)=>{n.d(i,{R:()=>o,x:()=>c});var r=n(96540);const t={},s=r.createContext(t);function o(e){const i=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/792c8e11.21f032f3.js b/assets/js/792c8e11.21f032f3.js new file mode 100644 index 0000000..3f9110c --- /dev/null +++ b/assets/js/792c8e11.21f032f3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3633],{14513:(e,s,t)=>{t.r(s),t.d(s,{contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var i=t(74848),n=t(28453);const r={},l="Get features available for a subclass.",a={type:"api",id:"get-features-available-for-a-subclass",title:"Get features available for a subclass.",description:"",slug:"/get-features-available-for-a-subclass",frontMatter:{},api:{tags:["Subclasses"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subclass to get.\n",schema:{type:"string",enum:["berserker","champion","devotion","draconic","evocation","fiend","hunter","land","life","lore","open-hand","thief"],example:"fiend"}}],responses:{200:{description:"List of features for the subclass.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get features available for a subclass.",method:"get",path:"/api/subclasses/{index}/features",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get features available for a subclass.",description:{type:"text/plain"},url:{path:["api","subclasses",":index","features"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subclass to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-features-available-for-a-subclass",previous:{title:"Get a subclass by index.",permalink:"/docs/api/get-a-subclass-by-index"},next:{title:"Get all level resources for a subclass.",permalink:"/docs/api/get-all-level-resources-for-a-subclass"}},c=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"get-features-available-for-a-subclass",children:"Get features available for a subclass."})}),"\n",(0,i.jsx)(s.p,{children:"Get features available for a subclass."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," [",(0,i.jsx)(s.code,{children:"berserker"}),", ",(0,i.jsx)(s.code,{children:"champion"}),", ",(0,i.jsx)(s.code,{children:"devotion"}),", ",(0,i.jsx)(s.code,{children:"draconic"}),", ",(0,i.jsx)(s.code,{children:"evocation"}),", ",(0,i.jsx)(s.code,{children:"fiend"}),", ",(0,i.jsx)(s.code,{children:"hunter"}),", ",(0,i.jsx)(s.code,{children:"land"}),", ",(0,i.jsx)(s.code,{children:"life"}),", ",(0,i.jsx)(s.code,{children:"lore"}),", ",(0,i.jsx)(s.code,{children:"open-hand"}),", ",(0,i.jsx)(s.code,{children:"thief"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"index"})," of the subclass to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"List of features for the subclass."})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"count"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"results"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},28453:(e,s,t)=>{t.d(s,{R:()=>l,x:()=>a});var i=t(96540);const n={},r=i.createContext(n);function l(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/792c8e11.95bab85a.js b/assets/js/792c8e11.95bab85a.js deleted file mode 100644 index 4e1fc75..0000000 --- a/assets/js/792c8e11.95bab85a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3633],{14513:(e,s,t)=>{t.r(s),t.d(s,{contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var i=t(74848),n=t(28453);const r={},l="Get features available for a subclass.",a={type:"api",id:"get-features-available-for-a-subclass",title:"Get features available for a subclass.",description:"",slug:"/get-features-available-for-a-subclass",frontMatter:{},api:{tags:["Subclasses"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subclass to get.\n",schema:{type:"string",enum:["berserker","champion","devotion","draconic","evocation","fiend","hunter","land","life","lore","open-hand","thief"],example:"fiend"}}],responses:{200:{description:"List of features for the subclass.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get features available for a subclass.",method:"get",path:"/api/subclasses/{index}/features",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get features available for a subclass.",description:{type:"text/plain"},url:{path:["api","subclasses",":index","features"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subclass to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-features-available-for-a-subclass",previous:{title:"Get a subclass by index.",permalink:"/docs/api/get-a-subclass-by-index"},next:{title:"Get all level resources for a subclass.",permalink:"/docs/api/get-all-level-resources-for-a-subclass"}},c=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"get-features-available-for-a-subclass",children:"Get features available for a subclass."})}),"\n",(0,i.jsx)(s.p,{children:"Get features available for a subclass."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," [",(0,i.jsx)(s.code,{children:"berserker"}),", ",(0,i.jsx)(s.code,{children:"champion"}),", ",(0,i.jsx)(s.code,{children:"devotion"}),", ",(0,i.jsx)(s.code,{children:"draconic"}),", ",(0,i.jsx)(s.code,{children:"evocation"}),", ",(0,i.jsx)(s.code,{children:"fiend"}),", ",(0,i.jsx)(s.code,{children:"hunter"}),", ",(0,i.jsx)(s.code,{children:"land"}),", ",(0,i.jsx)(s.code,{children:"life"}),", ",(0,i.jsx)(s.code,{children:"lore"}),", ",(0,i.jsx)(s.code,{children:"open-hand"}),", ",(0,i.jsx)(s.code,{children:"thief"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"index"})," of the subclass to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"List of features for the subclass."})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"count"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"results"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},28453:(e,s,t)=>{t.d(s,{R:()=>l,x:()=>a});var i=t(96540);const n={},r=i.createContext(n);function l(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7c914a69.6263894a.js b/assets/js/7c914a69.6263894a.js deleted file mode 100644 index 1b36e11..0000000 --- a/assets/js/7c914a69.6263894a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8317],{99173:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>l,default:()=>d,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var n=r(74848),s=r(28453);const t={},l="Get a race by index.",o={type:"api",id:"get-a-race-by-index",title:"Get a race by index.",description:"",slug:"/get-a-race-by-index",frontMatter:{},api:{description:"Each race grants your character ability and skill bonuses as well as racial traits.",tags:["Races"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the race to get.\n",schema:{type:"string",enum:["dragonborn","dwarf","elf","gnome","half-elf","half-orc","halfling","human","tiefling"],example:"elf"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Race`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},speed:{description:"Base move speed for this race (in feet per round).",type:"number"},ability_bonuses:{description:"Racial bonuses to ability scores.",type:"array",items:{type:"object",properties:{bonus:{description:"Bonus amount for this ability score.",type:"number"},ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},alignment:{description:"Flavor description of likely alignments this race takes.",type:"string"},age:{description:"Flavor description of possible ages for this race.",type:"string"},size:{description:"Size class of this race.",type:"string"},size_description:{description:"Flavor description of height and weight for this race.",type:"string"},starting_proficiencies:{description:"Starting proficiencies for all new characters of this race.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},starting_proficiency_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},languages:{description:"Starting languages for all new characters of this race.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},language_desc:{description:"Flavor description of the languages this race knows.",type:"string"},traits:{description:"Racial traits that provide benefits to its members.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},subraces:{description:"All possible subraces that this race includes.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"elf",name:"Elf",url:"/api/races/elf",ability_bonuses:[{ability_score:{index:"dex",name:"DEX",url:"/api/ability-scores/dex"},bonus:2}],age:"Although elves reach physical maturity at about the same age as humans, the elven understanding of adulthood goes beyond physical growth to encompass worldly experience. An elf typically claims adulthood and an adult name around the age of 100 and can live to be 750 years old.",alignment:"Elves love freedom, variety, and self-expression, so they lean strongly toward the gentler aspects of chaos. They value and protect others' freedom as well as their own, and they are more often good than not. The drow are an exception; their exile has made them vicious and dangerous. Drow are more often evil than not.",language_desc:"You can speak, read, and write Common and Elvish. Elvish is fluid, with subtle intonations and intricate grammar. Elven literature is rich and varied, and their songs and poems are famous among other races. Many bards learn their language so they can add Elvish ballads to their repertoires.",languages:[{index:"common",name:"Common",url:"/api/languages/common"},{index:"elvish",name:"Elvish",url:"/api/languages/elvish"}],size:"Medium",size_description:"Elves range from under 5 to over 6 feet tall and have slender builds. Your size is Medium.",speed:30,starting_proficiencies:[{index:"skill-perception",name:"Skill: Perception",url:"/api/proficiencies/skill-perception"}],subraces:[{index:"high-elf",name:"High Elf",url:"/api/subraces/high-elf"}],traits:[{index:"darkvision",name:"Darkvision",url:"/api/traits/darkvision"},{index:"fey-ancestry",name:"Fey Ancestry",url:"/api/traits/fey-ancestry"},{index:"trance",name:"Trance",url:"/api/traits/trance"}]}}}}},method:"get",path:"/api/races/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a race by index.",description:{content:"Each race grants your character ability and skill bonuses as well as racial traits.",type:"text/plain"},url:{path:["api","races",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the race to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-race-by-index",previous:{title:"Get a proficiency by index.",permalink:"/docs/api/get-a-proficiency-by-index"},next:{title:"Get subraces available for a race.",permalink:"/docs/api/get-subraces-available-for-a-race"}},c=[];function a(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-race-by-index",children:"Get a race by index."})}),"\n",(0,n.jsx)(i.p,{children:"Each race grants your character ability and skill bonuses as well as racial traits."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"dragonborn"}),", ",(0,n.jsx)(i.code,{children:"dwarf"}),", ",(0,n.jsx)(i.code,{children:"elf"}),", ",(0,n.jsx)(i.code,{children:"gnome"}),", ",(0,n.jsx)(i.code,{children:"half-elf"}),", ",(0,n.jsx)(i.code,{children:"half-orc"}),", ",(0,n.jsx)(i.code,{children:"halfling"}),", ",(0,n.jsx)(i.code,{children:"human"}),", ",(0,n.jsx)(i.code,{children:"tiefling"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the race to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"speed"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Base move speed for this race (in feet per round)."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_bonuses"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Racial bonuses to ability scores."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"bonus"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Bonus amount for this ability score."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_score"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"alignment"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Flavor description of likely alignments this race takes."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"age"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Flavor description of possible ages for this race."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"size"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Size class of this race."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"size_description"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Flavor description of height and weight for this race."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_proficiencies"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Starting proficiencies for all new characters of this race."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_proficiency_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"languages"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Starting languages for all new characters of this race."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"language_desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Flavor description of the languages this race knows."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"traits"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Racial traits that provide benefits to its members."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"subraces"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"All possible subraces that this race includes."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>l,x:()=>o});var n=r(96540);const s={},t=n.createContext(s);function l(e){const i=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),n.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7c914a69.ecc4baaf.js b/assets/js/7c914a69.ecc4baaf.js new file mode 100644 index 0000000..ffd633c --- /dev/null +++ b/assets/js/7c914a69.ecc4baaf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8317],{99173:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>o,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>a});var n=r(74848),s=r(28453);const t={},o="Get a race by index.",l={type:"api",id:"get-a-race-by-index",title:"Get a race by index.",description:"",slug:"/get-a-race-by-index",frontMatter:{},api:{description:"Each race grants your character ability and skill bonuses as well as racial traits.",tags:["Races"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the race to get.\n",schema:{type:"string",enum:["dragonborn","dwarf","elf","gnome","half-elf","half-orc","halfling","human","tiefling"],example:"elf"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Race`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},speed:{description:"Base move speed for this race (in feet per round).",type:"number"},ability_bonuses:{description:"Racial bonuses to ability scores.",type:"array",items:{type:"object",properties:{bonus:{description:"Bonus amount for this ability score.",type:"number"},ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},alignment:{description:"Flavor description of likely alignments this race takes.",type:"string"},age:{description:"Flavor description of possible ages for this race.",type:"string"},size:{description:"Size class of this race.",type:"string"},size_description:{description:"Flavor description of height and weight for this race.",type:"string"},starting_proficiencies:{description:"Starting proficiencies for all new characters of this race.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},starting_proficiency_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},languages:{description:"Starting languages for all new characters of this race.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},language_desc:{description:"Flavor description of the languages this race knows.",type:"string"},traits:{description:"Racial traits that provide benefits to its members.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},subraces:{description:"All possible subraces that this race includes.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{index:"elf",name:"Elf",url:"/api/races/elf",ability_bonuses:[{ability_score:{index:"dex",name:"DEX",url:"/api/ability-scores/dex"},bonus:2}],age:"Although elves reach physical maturity at about the same age as humans, the elven understanding of adulthood goes beyond physical growth to encompass worldly experience. An elf typically claims adulthood and an adult name around the age of 100 and can live to be 750 years old.",alignment:"Elves love freedom, variety, and self-expression, so they lean strongly toward the gentler aspects of chaos. They value and protect others' freedom as well as their own, and they are more often good than not. The drow are an exception; their exile has made them vicious and dangerous. Drow are more often evil than not.",language_desc:"You can speak, read, and write Common and Elvish. Elvish is fluid, with subtle intonations and intricate grammar. Elven literature is rich and varied, and their songs and poems are famous among other races. Many bards learn their language so they can add Elvish ballads to their repertoires.",languages:[{index:"common",name:"Common",url:"/api/languages/common"},{index:"elvish",name:"Elvish",url:"/api/languages/elvish"}],size:"Medium",size_description:"Elves range from under 5 to over 6 feet tall and have slender builds. Your size is Medium.",speed:30,starting_proficiencies:[{index:"skill-perception",name:"Skill: Perception",url:"/api/proficiencies/skill-perception"}],subraces:[{index:"high-elf",name:"High Elf",url:"/api/subraces/high-elf"}],traits:[{index:"darkvision",name:"Darkvision",url:"/api/traits/darkvision"},{index:"fey-ancestry",name:"Fey Ancestry",url:"/api/traits/fey-ancestry"},{index:"trance",name:"Trance",url:"/api/traits/trance"}]}}}}},method:"get",path:"/api/races/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a race by index.",description:{content:"Each race grants your character ability and skill bonuses as well as racial traits.",type:"text/plain"},url:{path:["api","races",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the race to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-race-by-index",previous:{title:"Get a proficiency by index.",permalink:"/docs/api/get-a-proficiency-by-index"},next:{title:"Get subraces available for a race.",permalink:"/docs/api/get-subraces-available-for-a-race"}},a=[];function c(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-race-by-index",children:"Get a race by index."})}),"\n",(0,n.jsx)(i.p,{children:"Each race grants your character ability and skill bonuses as well as racial traits."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"dragonborn"}),", ",(0,n.jsx)(i.code,{children:"dwarf"}),", ",(0,n.jsx)(i.code,{children:"elf"}),", ",(0,n.jsx)(i.code,{children:"gnome"}),", ",(0,n.jsx)(i.code,{children:"half-elf"}),", ",(0,n.jsx)(i.code,{children:"half-orc"}),", ",(0,n.jsx)(i.code,{children:"halfling"}),", ",(0,n.jsx)(i.code,{children:"human"}),", ",(0,n.jsx)(i.code,{children:"tiefling"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the race to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"speed"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Base move speed for this race (in feet per round)."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_bonuses"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Racial bonuses to ability scores."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"bonus"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Bonus amount for this ability score."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_score"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"alignment"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Flavor description of likely alignments this race takes."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"age"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Flavor description of possible ages for this race."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"size"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Size class of this race."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"size_description"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Flavor description of height and weight for this race."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_proficiencies"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Starting proficiencies for all new characters of this race."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_proficiency_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"languages"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Starting languages for all new characters of this race."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"language_desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Flavor description of the languages this race knows."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"traits"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Racial traits that provide benefits to its members."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"subraces"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"All possible subraces that this race includes."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>o,x:()=>l});var n=r(96540);const s={},t=n.createContext(s);function o(e){const i=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/85848f1c.695a5436.js b/assets/js/85848f1c.695a5436.js deleted file mode 100644 index f8abede..0000000 --- a/assets/js/85848f1c.695a5436.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9840],{75246:(e,n,i)=>{i.r(n),i.d(n,{contentTitle:()=>d,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var t=i(74848),s=i(28453);const r={},d="Get a condition by index.",a={type:"api",id:"get-a-condition-by-index",title:"Get a condition by index.",description:"",slug:"/get-a-condition-by-index",frontMatter:{},api:{description:"# Condition\n\nA condition alters a creature\u2019s capabilities in a variety of ways and can \narise as a result of a spell, a class feature, a monster\u2019s attack, or other \neffect. Most conditions, such as blinded, are impairments, but a few, such \nas invisible, can be advantageous.\n",tags:["Game Mechanics"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the condition to get.\n",schema:{type:"string",enum:["blinded","charmed","deafened","exhaustion","frightened","grappled","incapacitated","invisible","paralyzed","petrified","poisoned","prone","restrained","stunned","unconscious"],example:"blinded"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Condition`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}}}},example:{index:"blinded",name:"Blinded",url:"/api/conditions/blinded",desc:["- A blinded creature can't see and automatically fails any ability check that requires sight.","- Attack rolls against the creature have advantage, and the creature's attack rolls have disadvantage."]}}}}},method:"get",path:"/api/conditions/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a condition by index.",description:{content:"# Condition\n\nA condition alters a creature\u2019s capabilities in a variety of ways and can \narise as a result of a spell, a class feature, a monster\u2019s attack, or other \neffect. Most conditions, such as blinded, are impairments, but a few, such \nas invisible, can be advantageous.\n",type:"text/plain"},url:{path:["api","conditions",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the condition to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-condition-by-index",previous:{title:"Get spells of the requested level available to the class.",permalink:"/docs/api/get-spells-of-the-requested-level-available-to-the-class"},next:{title:"Get a damage type by index.",permalink:"/docs/api/get-a-damage-type-by-index"}},o=[];function c(e){const n={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"get-a-condition-by-index",children:"Get a condition by index."})}),"\n",(0,t.jsx)(n.h1,{id:"condition",children:"Condition"}),"\n",(0,t.jsx)(n.p,{children:"A condition alters a creature\u2019s capabilities in a variety of ways and can\narise as a result of a spell, a class feature, a monster\u2019s attack, or other\neffect. Most conditions, such as blinded, are impairments, but a few, such\nas invisible, can be advantageous."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Possible values:"})," [",(0,t.jsx)(n.code,{children:"blinded"}),", ",(0,t.jsx)(n.code,{children:"charmed"}),", ",(0,t.jsx)(n.code,{children:"deafened"}),", ",(0,t.jsx)(n.code,{children:"exhaustion"}),", ",(0,t.jsx)(n.code,{children:"frightened"}),", ",(0,t.jsx)(n.code,{children:"grappled"}),", ",(0,t.jsx)(n.code,{children:"incapacitated"}),", ",(0,t.jsx)(n.code,{children:"invisible"}),", ",(0,t.jsx)(n.code,{children:"paralyzed"}),", ",(0,t.jsx)(n.code,{children:"petrified"}),", ",(0,t.jsx)(n.code,{children:"poisoned"}),", ",(0,t.jsx)(n.code,{children:"prone"}),", ",(0,t.jsx)(n.code,{children:"restrained"}),", ",(0,t.jsx)(n.code,{children:"stunned"}),", ",(0,t.jsx)(n.code,{children:"unconscious"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"index"})," of the condition to get."]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Description of the resource."})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>a});var t=i(96540);const s={},r=t.createContext(s);function d(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/85848f1c.8c5b2da9.js b/assets/js/85848f1c.8c5b2da9.js new file mode 100644 index 0000000..3de93ca --- /dev/null +++ b/assets/js/85848f1c.8c5b2da9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9840],{75246:(e,n,i)=>{i.r(n),i.d(n,{contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>o});var t=i(74848),s=i(28453);const r={},a="Get a condition by index.",d={type:"api",id:"get-a-condition-by-index",title:"Get a condition by index.",description:"",slug:"/get-a-condition-by-index",frontMatter:{},api:{description:"# Condition\n\nA condition alters a creature\u2019s capabilities in a variety of ways and can \narise as a result of a spell, a class feature, a monster\u2019s attack, or other \neffect. Most conditions, such as blinded, are impairments, but a few, such \nas invisible, can be advantageous.\n",tags:["Game Mechanics"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the condition to get.\n",schema:{type:"string",enum:["blinded","charmed","deafened","exhaustion","frightened","grappled","incapacitated","invisible","paralyzed","petrified","poisoned","prone","restrained","stunned","unconscious"],example:"blinded"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Condition`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}}}},example:{index:"blinded",name:"Blinded",url:"/api/conditions/blinded",desc:["- A blinded creature can't see and automatically fails any ability check that requires sight.","- Attack rolls against the creature have advantage, and the creature's attack rolls have disadvantage."]}}}}},method:"get",path:"/api/conditions/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a condition by index.",description:{content:"# Condition\n\nA condition alters a creature\u2019s capabilities in a variety of ways and can \narise as a result of a spell, a class feature, a monster\u2019s attack, or other \neffect. Most conditions, such as blinded, are impairments, but a few, such \nas invisible, can be advantageous.\n",type:"text/plain"},url:{path:["api","conditions",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the condition to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-condition-by-index",previous:{title:"Get spells of the requested level available to the class.",permalink:"/docs/api/get-spells-of-the-requested-level-available-to-the-class"},next:{title:"Get a damage type by index.",permalink:"/docs/api/get-a-damage-type-by-index"}},o=[];function c(e){const n={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"get-a-condition-by-index",children:"Get a condition by index."})}),"\n",(0,t.jsx)(n.h1,{id:"condition",children:"Condition"}),"\n",(0,t.jsx)(n.p,{children:"A condition alters a creature\u2019s capabilities in a variety of ways and can\narise as a result of a spell, a class feature, a monster\u2019s attack, or other\neffect. Most conditions, such as blinded, are impairments, but a few, such\nas invisible, can be advantageous."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Possible values:"})," [",(0,t.jsx)(n.code,{children:"blinded"}),", ",(0,t.jsx)(n.code,{children:"charmed"}),", ",(0,t.jsx)(n.code,{children:"deafened"}),", ",(0,t.jsx)(n.code,{children:"exhaustion"}),", ",(0,t.jsx)(n.code,{children:"frightened"}),", ",(0,t.jsx)(n.code,{children:"grappled"}),", ",(0,t.jsx)(n.code,{children:"incapacitated"}),", ",(0,t.jsx)(n.code,{children:"invisible"}),", ",(0,t.jsx)(n.code,{children:"paralyzed"}),", ",(0,t.jsx)(n.code,{children:"petrified"}),", ",(0,t.jsx)(n.code,{children:"poisoned"}),", ",(0,t.jsx)(n.code,{children:"prone"}),", ",(0,t.jsx)(n.code,{children:"restrained"}),", ",(0,t.jsx)(n.code,{children:"stunned"}),", ",(0,t.jsx)(n.code,{children:"unconscious"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"index"})," of the condition to get."]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Description of the resource."})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>d});var t=i(96540);const s={},r=t.createContext(s);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8e1b9ec5.78cf7205.js b/assets/js/8e1b9ec5.78cf7205.js new file mode 100644 index 0000000..74d61e9 --- /dev/null +++ b/assets/js/8e1b9ec5.78cf7205.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3437],{14340:(e,t,n)=>{n.r(t),n.d(t,{contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var r=n(74848),i=n(28453);const o={},s="Get an equipment item by index.",p={type:"api",id:"get-an-equipment-item-by-index",title:"Get an equipment item by index.",description:"",slug:"/get-an-equipment-item-by-index",frontMatter:{},api:{description:"# Equipment\n\nOpportunities abound to find treasure, equipment, weapons, armor, and more \nin the dungeons you explore. Normally, you can sell your treasures and \ntrinkets when you return to a town or other settlement, provided that you \ncan find buyers and merchants interested in your loot.\n",tags:["Equipment"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the equipment to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `equipment`.\n",schema:{type:"string",example:"club"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Equipment`\n",anyOf:[{description:"`Weapon`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},equipment_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},weapon_category:{description:"The category of weapon this falls into.",type:"string"},weapon_range:{description:"Whether this is a Melee or Ranged weapon.",type:"string"},category_range:{description:"A combination of weapon_category and weapon_range.",type:"string"},range:{type:"object",properties:{normal:{description:"The weapon's normal range in feet.",type:"number"},long:{description:"The weapon's long range in feet.",type:"number"}}},damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},two_handed_damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},properties:{description:"A list of the properties this weapon has.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},cost:{description:"`Cost`\n",type:"object",properties:{quantity:{description:"Numerical amount of coins.",type:"number"},unit:{description:"Unit of coinage.",type:"string"}}},weight:{description:"How much the equipment weighs.",type:"number"}}},{description:"`Armor`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},equipment_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},armor_category:{description:"The category of armor this falls into.",type:"string"},armor_class:{description:"Details on how to calculate armor class.",type:"object",additionalProperties:{type:"string"}},str_minimum:{description:"Minimum STR required to use this armor.",type:"number"},stealth_disadvantage:{description:"Whether the armor gives disadvantage for Stealth.",type:"boolean"},cost:{description:"`Cost`\n",type:"object",properties:{quantity:{description:"Numerical amount of coins.",type:"number"},unit:{description:"Unit of coinage.",type:"string"}}},weight:{description:"How much the equipment weighs.",type:"number"}}},{description:"`Gear`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},equipment_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},gear_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},cost:{description:"`Cost`\n",type:"object",properties:{quantity:{description:"Numerical amount of coins.",type:"number"},unit:{description:"Unit of coinage.",type:"string"}}},weight:{description:"How much the equipment weighs.",type:"number"}}},{description:"`EquipmentPack`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},equipment_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},gear_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},cost:{description:"`Cost`\n",type:"object",properties:{quantity:{description:"Numerical amount of coins.",type:"number"},unit:{description:"Unit of coinage.",type:"string"}}},contents:{description:"The list of adventuring gear in the pack.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}]},example:{category_range:"Simple Melee",contents:[],cost:{quantity:1,unit:"sp"},damage:{damage_dice:"1d4",damage_type:{index:"bludgeoning",name:"Bludgeoning",url:"/api/damage-types/bludgeoning"}},desc:[],equipment_category:{index:"weapon",name:"Weapon",url:"/api/equipment-categories/weapon"},index:"club",name:"Club",properties:[{index:"light",name:"Light",url:"/api/weapon-properties/light"},{index:"monk",name:"Monk",url:"/api/weapon-properties/monk"}],range:{long:null,normal:5},special:[],url:"/api/equipment/club",weapon_category:"Simple",weapon_range:"Melee",weight:2}}}}},method:"get",path:"/api/equipment/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get an equipment item by index.",description:{content:"# Equipment\n\nOpportunities abound to find treasure, equipment, weapons, armor, and more \nin the dungeons you explore. Normally, you can sell your treasures and \ntrinkets when you return to a town or other settlement, provided that you \ncan find buyers and merchants interested in your loot.\n",type:"text/plain"},url:{path:["api","equipment",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the equipment to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `equipment`.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-an-equipment-item-by-index",previous:{title:"Get a damage type by index.",permalink:"/docs/api/get-a-damage-type-by-index"},next:{title:"Get an equipment category by index.",permalink:"/docs/api/get-an-equipment-category-by-index"}},c=[];function a(e){const t={a:"a",code:"code",h1:"h1",header:"header",p:"p",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"get-an-equipment-item-by-index",children:"Get an equipment item by index."})}),"\n",(0,r.jsx)(t.h1,{id:"equipment",children:"Equipment"}),"\n",(0,r.jsx)(t.p,{children:"Opportunities abound to find treasure, equipment, weapons, armor, and more\nin the dungeons you explore. Normally, you can sell your treasures and\ntrinkets when you return to a town or other settlement, provided that you\ncan find buyers and merchants interested in your loot."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,r.jsxs)(t.p,{children:["The ",(0,r.jsx)(t.code,{children:"index"})," of the equipment to get."]}),(0,r.jsxs)(t.p,{children:["Available values can be found in the ",(0,r.jsx)(t.a,{href:"#get-/api/-endpoint-",children:(0,r.jsx)(t.code,{children:"ResourceList"})})," for ",(0,r.jsx)(t.code,{children:"equipment"}),"."]})]})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(t.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("span",{style:{opacity:"0.6"},children:" undefined"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"Equipment"})})})]})})})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>p});var r=n(96540);const i={},o=r.createContext(i);function s(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function p(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8e1b9ec5.8500bd3c.js b/assets/js/8e1b9ec5.8500bd3c.js deleted file mode 100644 index 7b40897..0000000 --- a/assets/js/8e1b9ec5.8500bd3c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3437],{14340:(e,t,r)=>{r.r(t),r.d(t,{contentTitle:()=>s,default:()=>a,frontMatter:()=>o,metadata:()=>c,toc:()=>p});var n=r(74848),i=r(28453);const o={},s="Get an equipment item by index.",c={type:"api",id:"get-an-equipment-item-by-index",title:"Get an equipment item by index.",description:"",slug:"/get-an-equipment-item-by-index",frontMatter:{},api:{description:"# Equipment\n\nOpportunities abound to find treasure, equipment, weapons, armor, and more \nin the dungeons you explore. Normally, you can sell your treasures and \ntrinkets when you return to a town or other settlement, provided that you \ncan find buyers and merchants interested in your loot.\n",tags:["Equipment"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the equipment to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `equipment`.\n",schema:{type:"string",example:"club"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Equipment`\n",anyOf:[{description:"`Weapon`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},equipment_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},weapon_category:{description:"The category of weapon this falls into.",type:"string"},weapon_range:{description:"Whether this is a Melee or Ranged weapon.",type:"string"},category_range:{description:"A combination of weapon_category and weapon_range.",type:"string"},range:{type:"object",properties:{normal:{description:"The weapon's normal range in feet.",type:"number"},long:{description:"The weapon's long range in feet.",type:"number"}}},damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},two_handed_damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},properties:{description:"A list of the properties this weapon has.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},cost:{description:"`Cost`\n",type:"object",properties:{quantity:{description:"Numerical amount of coins.",type:"number"},unit:{description:"Unit of coinage.",type:"string"}}},weight:{description:"How much the equipment weighs.",type:"number"}}},{description:"`Armor`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},equipment_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},armor_category:{description:"The category of armor this falls into.",type:"string"},armor_class:{description:"Details on how to calculate armor class.",type:"object",additionalProperties:{type:"string"}},str_minimum:{description:"Minimum STR required to use this armor.",type:"number"},stealth_disadvantage:{description:"Whether the armor gives disadvantage for Stealth.",type:"boolean"},cost:{description:"`Cost`\n",type:"object",properties:{quantity:{description:"Numerical amount of coins.",type:"number"},unit:{description:"Unit of coinage.",type:"string"}}},weight:{description:"How much the equipment weighs.",type:"number"}}},{description:"`Gear`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},equipment_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},gear_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},cost:{description:"`Cost`\n",type:"object",properties:{quantity:{description:"Numerical amount of coins.",type:"number"},unit:{description:"Unit of coinage.",type:"string"}}},weight:{description:"How much the equipment weighs.",type:"number"}}},{description:"`EquipmentPack`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},equipment_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},gear_category:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},cost:{description:"`Cost`\n",type:"object",properties:{quantity:{description:"Numerical amount of coins.",type:"number"},unit:{description:"Unit of coinage.",type:"string"}}},contents:{description:"The list of adventuring gear in the pack.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}]},example:{category_range:"Simple Melee",contents:[],cost:{quantity:1,unit:"sp"},damage:{damage_dice:"1d4",damage_type:{index:"bludgeoning",name:"Bludgeoning",url:"/api/damage-types/bludgeoning"}},desc:[],equipment_category:{index:"weapon",name:"Weapon",url:"/api/equipment-categories/weapon"},index:"club",name:"Club",properties:[{index:"light",name:"Light",url:"/api/weapon-properties/light"},{index:"monk",name:"Monk",url:"/api/weapon-properties/monk"}],range:{long:null,normal:5},special:[],url:"/api/equipment/club",weapon_category:"Simple",weapon_range:"Melee",weight:2}}}}},method:"get",path:"/api/equipment/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get an equipment item by index.",description:{content:"# Equipment\n\nOpportunities abound to find treasure, equipment, weapons, armor, and more \nin the dungeons you explore. Normally, you can sell your treasures and \ntrinkets when you return to a town or other settlement, provided that you \ncan find buyers and merchants interested in your loot.\n",type:"text/plain"},url:{path:["api","equipment",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the equipment to get.\n\nAvailable values can be found in the [`ResourceList`](#get-/api/-endpoint-) for `equipment`.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-an-equipment-item-by-index",previous:{title:"Get a damage type by index.",permalink:"/docs/api/get-a-damage-type-by-index"},next:{title:"Get an equipment category by index.",permalink:"/docs/api/get-an-equipment-category-by-index"}},p=[];function d(e){const t={a:"a",code:"code",h1:"h1",header:"header",p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"get-an-equipment-item-by-index",children:"Get an equipment item by index."})}),"\n",(0,n.jsx)(t.h1,{id:"equipment",children:"Equipment"}),"\n",(0,n.jsx)(t.p,{children:"Opportunities abound to find treasure, equipment, weapons, armor, and more\nin the dungeons you explore. Normally, you can sell your treasures and\ntrinkets when you return to a town or other settlement, provided that you\ncan find buyers and merchants interested in your loot."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,n.jsxs)(t.p,{children:["The ",(0,n.jsx)(t.code,{children:"index"})," of the equipment to get."]}),(0,n.jsxs)(t.p,{children:["Available values can be found in the ",(0,n.jsx)(t.a,{href:"#get-/api/-endpoint-",children:(0,n.jsx)(t.code,{children:"ResourceList"})})," for ",(0,n.jsx)(t.code,{children:"equipment"}),"."]})]})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(t.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("span",{style:{opacity:"0.6"},children:" undefined"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"Equipment"})})})]})})})]})})]})})})]})]})}function a(e){void 0===e&&(e={});const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>c});var n=r(96540);const i={},o=n.createContext(i);function s(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8e53799d.01fed9f1.js b/assets/js/8e53799d.01fed9f1.js deleted file mode 100644 index 212a116..0000000 --- a/assets/js/8e53799d.01fed9f1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1169],{52022:(e,n,i)=>{i.r(n),i.d(n,{contentTitle:()=>a,default:()=>o,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var s=i(74848),t=i(28453);const r={},a="Get a language by index.",d={type:"api",id:"get-a-language-by-index",title:"Get a language by index.",description:"",slug:"/get-a-language-by-index",frontMatter:{},api:{description:"# Language\n\nYour race indicates the languages your character can speak by default, and your background might give you access to one or more additional languages of your choice. [[SRD p59](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=59)]\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the language to get.\n",schema:{type:"string",enum:["abyssal","celestial","common","deep-speech","draconic","dwarvish","elvish","giant","gnomish","goblin","halfling","infernal","orc","primordial","sylvan","undercommon"],example:"abyssal"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Language`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Brief description of the language.",type:"string"},type:{type:"string",enum:["Standard","Exotic"]},script:{description:"Script used for writing in the language.",type:"string"},typical_speakers:{description:"List of races that tend to speak the language.",type:"array",items:{type:"string"}}}},example:{index:"elvish",name:"Elvish",url:"/api/languages/elvish",desc:"Elvish is fluid, with subtle intonations and intricate grammar. Elven literature is rich and varied, and their songs and poems are famous among other races. Many bards learn their language so they can add Elvish ballads to their repertoires.",type:"Standard",script:"Elvish",typical_speakers:["Elves"]}}}}},method:"get",path:"/api/languages/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a language by index.",description:{content:"# Language\n\nYour race indicates the languages your character can speak by default, and your background might give you access to one or more additional languages of your choice. [[SRD p59](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=59)]\n",type:"text/plain"},url:{path:["api","languages",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the language to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-language-by-index",previous:{title:"Get a feature by index.",permalink:"/docs/api/get-a-feature-by-index"},next:{title:"Get a magic item by index.",permalink:"/docs/api/get-a-magic-item-by-index"}},l=[];function c(e){const n={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"get-a-language-by-index",children:"Get a language by index."})}),"\n",(0,s.jsx)(n.h1,{id:"language",children:"Language"}),"\n",(0,s.jsxs)(n.p,{children:["Your race indicates the languages your character can speak by default, and your background might give you access to one or more additional languages of your choice. [",(0,s.jsx)(n.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=59",children:"SRD p59"}),"]"]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Possible values:"})," [",(0,s.jsx)(n.code,{children:"abyssal"}),", ",(0,s.jsx)(n.code,{children:"celestial"}),", ",(0,s.jsx)(n.code,{children:"common"}),", ",(0,s.jsx)(n.code,{children:"deep-speech"}),", ",(0,s.jsx)(n.code,{children:"draconic"}),", ",(0,s.jsx)(n.code,{children:"dwarvish"}),", ",(0,s.jsx)(n.code,{children:"elvish"}),", ",(0,s.jsx)(n.code,{children:"giant"}),", ",(0,s.jsx)(n.code,{children:"gnomish"}),", ",(0,s.jsx)(n.code,{children:"goblin"}),", ",(0,s.jsx)(n.code,{children:"halfling"}),", ",(0,s.jsx)(n.code,{children:"infernal"}),", ",(0,s.jsx)(n.code,{children:"orc"}),", ",(0,s.jsx)(n.code,{children:"primordial"}),", ",(0,s.jsx)(n.code,{children:"sylvan"}),", ",(0,s.jsx)(n.code,{children:"undercommon"}),"]"]})}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"index"})," of the language to get."]})})]})})})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsxs)("div",{style:{display:"flex"},children:[(0,s.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)("code",{children:"200"})}),(0,s.jsx)("div",{children:(0,s.jsx)(n.p,{children:"OK"})})]}),(0,s.jsx)("div",{children:(0,s.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Schema "}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{})]})})}),(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"level"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(n.p,{children:"Level of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"desc"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(n.p,{children:"Brief description of the language."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"type"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Possible values:"})," [",(0,s.jsx)(n.code,{children:"Standard"}),", ",(0,s.jsx)(n.code,{children:"Exotic"}),"]"]})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"script"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(n.p,{children:"Script used for writing in the language."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"typical_speakers"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(n.p,{children:"List of races that tend to speak the language."})})]})})]})]})})]})})})]})]})}function o(e){void 0===e&&(e={});const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>d});var s=i(96540);const t={},r=s.createContext(t);function a(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8e53799d.ff63513c.js b/assets/js/8e53799d.ff63513c.js new file mode 100644 index 0000000..e0eaf47 --- /dev/null +++ b/assets/js/8e53799d.ff63513c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1169],{52022:(e,n,i)=>{i.r(n),i.d(n,{contentTitle:()=>a,default:()=>o,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var t=i(74848),s=i(28453);const r={},a="Get a language by index.",d={type:"api",id:"get-a-language-by-index",title:"Get a language by index.",description:"",slug:"/get-a-language-by-index",frontMatter:{},api:{description:"# Language\n\nYour race indicates the languages your character can speak by default, and your background might give you access to one or more additional languages of your choice. [[SRD p59](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=59)]\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the language to get.\n",schema:{type:"string",enum:["abyssal","celestial","common","deep-speech","draconic","dwarvish","elvish","giant","gnomish","goblin","halfling","infernal","orc","primordial","sylvan","undercommon"],example:"abyssal"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Language`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Brief description of the language.",type:"string"},type:{type:"string",enum:["Standard","Exotic"]},script:{description:"Script used for writing in the language.",type:"string"},typical_speakers:{description:"List of races that tend to speak the language.",type:"array",items:{type:"string"}}}},example:{index:"elvish",name:"Elvish",url:"/api/languages/elvish",desc:"Elvish is fluid, with subtle intonations and intricate grammar. Elven literature is rich and varied, and their songs and poems are famous among other races. Many bards learn their language so they can add Elvish ballads to their repertoires.",type:"Standard",script:"Elvish",typical_speakers:["Elves"]}}}}},method:"get",path:"/api/languages/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a language by index.",description:{content:"# Language\n\nYour race indicates the languages your character can speak by default, and your background might give you access to one or more additional languages of your choice. [[SRD p59](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=59)]\n",type:"text/plain"},url:{path:["api","languages",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the language to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-language-by-index",previous:{title:"Get a feature by index.",permalink:"/docs/api/get-a-feature-by-index"},next:{title:"Get a magic item by index.",permalink:"/docs/api/get-a-magic-item-by-index"}},l=[];function c(e){const n={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"get-a-language-by-index",children:"Get a language by index."})}),"\n",(0,t.jsx)(n.h1,{id:"language",children:"Language"}),"\n",(0,t.jsxs)(n.p,{children:["Your race indicates the languages your character can speak by default, and your background might give you access to one or more additional languages of your choice. [",(0,t.jsx)(n.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=59",children:"SRD p59"}),"]"]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Possible values:"})," [",(0,t.jsx)(n.code,{children:"abyssal"}),", ",(0,t.jsx)(n.code,{children:"celestial"}),", ",(0,t.jsx)(n.code,{children:"common"}),", ",(0,t.jsx)(n.code,{children:"deep-speech"}),", ",(0,t.jsx)(n.code,{children:"draconic"}),", ",(0,t.jsx)(n.code,{children:"dwarvish"}),", ",(0,t.jsx)(n.code,{children:"elvish"}),", ",(0,t.jsx)(n.code,{children:"giant"}),", ",(0,t.jsx)(n.code,{children:"gnomish"}),", ",(0,t.jsx)(n.code,{children:"goblin"}),", ",(0,t.jsx)(n.code,{children:"halfling"}),", ",(0,t.jsx)(n.code,{children:"infernal"}),", ",(0,t.jsx)(n.code,{children:"orc"}),", ",(0,t.jsx)(n.code,{children:"primordial"}),", ",(0,t.jsx)(n.code,{children:"sylvan"}),", ",(0,t.jsx)(n.code,{children:"undercommon"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"index"})," of the language to get."]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Brief description of the language."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Possible values:"})," [",(0,t.jsx)(n.code,{children:"Standard"}),", ",(0,t.jsx)(n.code,{children:"Exotic"}),"]"]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"script"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Script used for writing in the language."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"typical_speakers"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"List of races that tend to speak the language."})})]})})]})]})})]})})})]})]})}function o(e){void 0===e&&(e={});const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>d});var t=i(96540);const s={},r=t.createContext(s);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8f6ee0c6.00173993.js b/assets/js/8f6ee0c6.00173993.js deleted file mode 100644 index 521bfb8..0000000 --- a/assets/js/8f6ee0c6.00173993.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3190],{72910:(e,i,t)=>{t.r(i),t.d(i,{contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>a});var n=t(74848),o=t(28453);const r={},s="Get a background by index.",l={type:"api",id:"get-a-background-by-index",title:"Get a background by index.",description:"",slug:"/get-a-background-by-index",frontMatter:{},api:{description:"# Background\n\nEvery story has a beginning. Your character's background reveals where you came from, how you became an adventurer, and your place in the world. Choosing a background provides you with important story cues about your character's identity. [[SRD p60](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=60)]\n\n_Note:_ acolyte is the only background included in the SRD.\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the background to get.\n",schema:{type:"string",enum:["acolyte"],example:"acolyte"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Background`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},starting_proficiencies:{description:"Starting proficiencies for all new characters of this background.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},starting_equipment:{description:"Starting equipment for all new characters of this background.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},starting_equipment_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},language_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},feature:{description:"Special feature granted to new characters of this background.",type:"object",properties:{name:{type:"string"},desc:{type:"array",items:{type:"string"}}}},personality_traits:{description:"Choice of personality traits for this background.",type:"object"},ideals:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},bonds:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},flaws:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}}},example:{index:"acolyte",name:"Acolyte",starting_proficiencies:[{index:"skill-insight",name:"Skill: Insight",url:"/api/proficiencies/skill-insight"},{index:"skill-religion",name:"Skill: Religion",url:"/api/proficiencies/skill-religion"}],language_options:{choose:2,type:"languages",from:{option_set_type:"resource_list",resource_list_url:"/api/languages"}},starting_equipment:[{equipment:{index:"clothes-common",name:"Clothes, common",url:"/api/equipment/clothes-common"},quantity:1},{equipment:{index:"pouch",name:"Pouch",url:"/api/equipment/pouch"},quantity:1}],starting_equipment_options:[{choose:1,type:"equipment",from:{option_set_type:"equipment_category",equipment_category:{index:"holy-symbols",name:"Holy Symbols",url:"/api/equipment-categories/holy-symbols"}}}],feature:{name:"Shelter of the Faithful",desc:["As an acolyte, you command the respect of those who share your faith, and you can perform the religious ceremonies of your deity. You and your adventuring companions can expect to receive free healing and care at a temple, shrine, or other established presence of your faith, though you must provide any material components needed for spells. Those who share your religion will support you (but only you) at a modest lifestyle.","You might also have ties to a specific temple dedicated to your chosen deity or pantheon, and you have a residence there. This could be the temple where you used to serve, if you remain on good terms with it, or a temple where you have found a new home. While near your temple, you can call upon the priests for assistance, provided the assistance you ask for is not hazardous and you remain in good standing with your temple."]},personality_traits:{choose:2,type:"personality_traits",from:{option_set_type:"options_array",options:[{option_type:"string",string:"I idolize a particular hero of my faith, and constantly refer to that person's deeds and example."},{option_type:"string",string:"I can find common ground between the fiercest enemies, empathizing with them and always working toward peace."},{option_type:"string",string:"I see omens in every event and action. The gods try to speak to us, we just need to listen."},{option_type:"string",string:"Nothing can shake my optimistic attitude."},{option_type:"string",string:"I quote (or misquote) sacred texts and proverbs in almost every situation."},{option_type:"string",string:"I am tolerant (or intolerant) of other faiths and respect (or condemn) the worship of other gods."},{option_type:"string",string:"I've enjoyed fine food, drink, and high society among my temple's elite. Rough living grates on me."},{option_type:"string",string:"I've spent so long in the temple that I have little practical experience dealing with people in the outside world."}]}},ideals:{choose:1,type:"ideals",from:{option_set_type:"options_array",options:[{option_type:"ideal",desc:"Tradition. The ancient traditions of worship and sacrifice must be preserved and upheld.",alignments:[{index:"lawful-good",name:"Lawful Good",url:"/api/alignments/lawful-good"},{index:"lawful-neutral",name:"Lawful Neutral",url:"/api/alignments/lawful-neutral"},{index:"lawful-evil",name:"Lawful Evil",url:"/api/alignments/lawful-evil"}]},{option_type:"ideal",desc:"Charity. I always try to help those in need, no matter what the personal cost.",alignments:[{index:"lawful-good",name:"Lawful Good",url:"/api/alignments/lawful-good"},{index:"neutral-good",name:"Neutral Good",url:"/api/alignments/neutral-good"},{index:"chaotic-good",name:"Chaotic Good",url:"/api/alignments/chaotic-good"}]},{option_type:"ideal",desc:"Change. We must help bring about the changes the gods are constantly working in the world.",alignments:[{index:"chaotic-good",name:"Chaotic Good",url:"/api/alignments/chaotic-good"},{index:"chaotic-neutral",name:"Chaotic Neutral",url:"/api/alignments/chaotic-neutral"},{index:"chaotic-evil",name:"Chaotic Evil",url:"/api/alignments/chaotic-evil"}]},{option_type:"ideal",desc:"Power. I hope to one day rise to the top of my faith's religious hierarchy.",alignments:[{index:"lawful-good",name:"Lawful Good",url:"/api/alignments/lawful-good"},{index:"lawful-neutral",name:"Lawful Neutral",url:"/api/alignments/lawful-neutral"},{index:"lawful-evil",name:"Lawful Evil",url:"/api/alignments/lawful-evil"}]},{option_type:"ideal",desc:"Faith. I trust that my deity will guide my actions. I have faith that if I work hard, things will go well.",alignments:[{index:"lawful-good",name:"Lawful Good",url:"/api/alignments/lawful-good"},{index:"lawful-neutral",name:"Lawful Neutral",url:"/api/alignments/lawful-neutral"},{index:"lawful-evil",name:"Lawful Evil",url:"/api/alignments/lawful-evil"}]},{option_type:"ideal",desc:"Aspiration. I seek to prove myself worthy of my god's favor by matching my actions against his or her teachings.",alignments:[{index:"lawful-good",name:"Lawful Good",url:"/api/alignments/lawful-good"},{index:"neutral-good",name:"Neutral Good",url:"/api/alignments/neutral-good"},{index:"chaotic-good",name:"Chaotic Good",url:"/api/alignments/chaotic-good"},{index:"lawful-neutral",name:"Lawful Neutral",url:"/api/alignments/lawful-neutral"},{index:"neutral",name:"Neutral",url:"/api/alignments/neutral"},{index:"chaotic-neutral",name:"Chaotic Neutral",url:"/api/alignments/chaotic-neutral"},{index:"lawful-evil",name:"Lawful Evil",url:"/api/alignments/lawful-evil"},{index:"neutral-evil",name:"Neutral Evil",url:"/api/alignments/neutral-evil"},{index:"chaotic-evil",name:"Chaotic Evil",url:"/api/alignments/chaotic-evil"}]}]}},bonds:{choose:1,type:"bonds",from:{option_set_type:"options_array",options:[{option_type:"string",string:"I would die to recover an ancient relic of my faith that was lost long ago."},{option_type:"string",string:"I will someday get revenge on the corrupt temple hierarchy who branded me a heretic."},{option_type:"string",string:"I owe my life to the priest who took me in when my parents died."},{option_type:"string",string:"Everything I do is for the common people."},{option_type:"string",string:"I will do anything to protect the temple where I served."},{option_type:"string",string:"I seek to preserve a sacred text that my enemies consider heretical and seek to destroy."}]}},flaws:{choose:1,type:"flaws",from:{option_set_type:"options_array",options:[{option_type:"string",string:"I judge others harshly, and myself even more severely."},{option_type:"string",string:"I put too much trust in those who wield power within my temple's hierarchy."},{option_type:"string",string:"My piety sometimes leads me to blindly trust those that profess faith in my god."},{option_type:"string",string:"I am inflexible in my thinking."},{option_type:"string",string:"I am suspicious of strangers and expect the worst of them."},{option_type:"string",string:"Once I pick a goal, I become obsessed with it to the detriment of everything else in my life."}]}},url:"/api/backgrounds/acolyte"}}}}},method:"get",path:"/api/backgrounds/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a background by index.",description:{content:"# Background\n\nEvery story has a beginning. Your character's background reveals where you came from, how you became an adventurer, and your place in the world. Choosing a background provides you with important story cues about your character's identity. [[SRD p60](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=60)]\n\n_Note:_ acolyte is the only background included in the SRD.\n",type:"text/plain"},url:{path:["api","backgrounds",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the background to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-background-by-index",previous:{title:"Get an alignment by index.",permalink:"/docs/api/get-an-alignment-by-index"},next:{title:"Get a class by index.",permalink:"/docs/api/get-a-class-by-index"}},a=[];function c(e){const i={a:"a",code:"code",em:"em",h1:"h1",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-background-by-index",children:"Get a background by index."})}),"\n",(0,n.jsx)(i.h1,{id:"background",children:"Background"}),"\n",(0,n.jsxs)(i.p,{children:["Every story has a beginning. Your character's background reveals where you came from, how you became an adventurer, and your place in the world. Choosing a background provides you with important story cues about your character's identity. [",(0,n.jsx)(i.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=60",children:"SRD p60"}),"]"]}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.em,{children:"Note:"})," acolyte is the only background included in the SRD."]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"acolyte"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the background to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_proficiencies"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Starting proficiencies for all new characters of this background."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_equipment"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Starting equipment for all new characters of this background."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_equipment_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"language_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"feature"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Special feature granted to new characters of this background."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"personality_traits"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Choice of personality traits for this background."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ideals"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"bonds"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"flaws"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,o.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>s,x:()=>l});var n=t(96540);const o={},r=n.createContext(o);function s(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8f6ee0c6.8a0f22f8.js b/assets/js/8f6ee0c6.8a0f22f8.js new file mode 100644 index 0000000..07073c3 --- /dev/null +++ b/assets/js/8f6ee0c6.8a0f22f8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3190],{72910:(e,i,t)=>{t.r(i),t.d(i,{contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var n=t(74848),o=t(28453);const r={},s="Get a background by index.",a={type:"api",id:"get-a-background-by-index",title:"Get a background by index.",description:"",slug:"/get-a-background-by-index",frontMatter:{},api:{description:"# Background\n\nEvery story has a beginning. Your character's background reveals where you came from, how you became an adventurer, and your place in the world. Choosing a background provides you with important story cues about your character's identity. [[SRD p60](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=60)]\n\n_Note:_ acolyte is the only background included in the SRD.\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the background to get.\n",schema:{type:"string",enum:["acolyte"],example:"acolyte"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Background`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},starting_proficiencies:{description:"Starting proficiencies for all new characters of this background.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},starting_equipment:{description:"Starting equipment for all new characters of this background.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},starting_equipment_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},language_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},feature:{description:"Special feature granted to new characters of this background.",type:"object",properties:{name:{type:"string"},desc:{type:"array",items:{type:"string"}}}},personality_traits:{description:"Choice of personality traits for this background.",type:"object"},ideals:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},bonds:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},flaws:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}}},example:{index:"acolyte",name:"Acolyte",starting_proficiencies:[{index:"skill-insight",name:"Skill: Insight",url:"/api/proficiencies/skill-insight"},{index:"skill-religion",name:"Skill: Religion",url:"/api/proficiencies/skill-religion"}],language_options:{choose:2,type:"languages",from:{option_set_type:"resource_list",resource_list_url:"/api/languages"}},starting_equipment:[{equipment:{index:"clothes-common",name:"Clothes, common",url:"/api/equipment/clothes-common"},quantity:1},{equipment:{index:"pouch",name:"Pouch",url:"/api/equipment/pouch"},quantity:1}],starting_equipment_options:[{choose:1,type:"equipment",from:{option_set_type:"equipment_category",equipment_category:{index:"holy-symbols",name:"Holy Symbols",url:"/api/equipment-categories/holy-symbols"}}}],feature:{name:"Shelter of the Faithful",desc:["As an acolyte, you command the respect of those who share your faith, and you can perform the religious ceremonies of your deity. You and your adventuring companions can expect to receive free healing and care at a temple, shrine, or other established presence of your faith, though you must provide any material components needed for spells. Those who share your religion will support you (but only you) at a modest lifestyle.","You might also have ties to a specific temple dedicated to your chosen deity or pantheon, and you have a residence there. This could be the temple where you used to serve, if you remain on good terms with it, or a temple where you have found a new home. While near your temple, you can call upon the priests for assistance, provided the assistance you ask for is not hazardous and you remain in good standing with your temple."]},personality_traits:{choose:2,type:"personality_traits",from:{option_set_type:"options_array",options:[{option_type:"string",string:"I idolize a particular hero of my faith, and constantly refer to that person's deeds and example."},{option_type:"string",string:"I can find common ground between the fiercest enemies, empathizing with them and always working toward peace."},{option_type:"string",string:"I see omens in every event and action. The gods try to speak to us, we just need to listen."},{option_type:"string",string:"Nothing can shake my optimistic attitude."},{option_type:"string",string:"I quote (or misquote) sacred texts and proverbs in almost every situation."},{option_type:"string",string:"I am tolerant (or intolerant) of other faiths and respect (or condemn) the worship of other gods."},{option_type:"string",string:"I've enjoyed fine food, drink, and high society among my temple's elite. Rough living grates on me."},{option_type:"string",string:"I've spent so long in the temple that I have little practical experience dealing with people in the outside world."}]}},ideals:{choose:1,type:"ideals",from:{option_set_type:"options_array",options:[{option_type:"ideal",desc:"Tradition. The ancient traditions of worship and sacrifice must be preserved and upheld.",alignments:[{index:"lawful-good",name:"Lawful Good",url:"/api/alignments/lawful-good"},{index:"lawful-neutral",name:"Lawful Neutral",url:"/api/alignments/lawful-neutral"},{index:"lawful-evil",name:"Lawful Evil",url:"/api/alignments/lawful-evil"}]},{option_type:"ideal",desc:"Charity. I always try to help those in need, no matter what the personal cost.",alignments:[{index:"lawful-good",name:"Lawful Good",url:"/api/alignments/lawful-good"},{index:"neutral-good",name:"Neutral Good",url:"/api/alignments/neutral-good"},{index:"chaotic-good",name:"Chaotic Good",url:"/api/alignments/chaotic-good"}]},{option_type:"ideal",desc:"Change. We must help bring about the changes the gods are constantly working in the world.",alignments:[{index:"chaotic-good",name:"Chaotic Good",url:"/api/alignments/chaotic-good"},{index:"chaotic-neutral",name:"Chaotic Neutral",url:"/api/alignments/chaotic-neutral"},{index:"chaotic-evil",name:"Chaotic Evil",url:"/api/alignments/chaotic-evil"}]},{option_type:"ideal",desc:"Power. I hope to one day rise to the top of my faith's religious hierarchy.",alignments:[{index:"lawful-good",name:"Lawful Good",url:"/api/alignments/lawful-good"},{index:"lawful-neutral",name:"Lawful Neutral",url:"/api/alignments/lawful-neutral"},{index:"lawful-evil",name:"Lawful Evil",url:"/api/alignments/lawful-evil"}]},{option_type:"ideal",desc:"Faith. I trust that my deity will guide my actions. I have faith that if I work hard, things will go well.",alignments:[{index:"lawful-good",name:"Lawful Good",url:"/api/alignments/lawful-good"},{index:"lawful-neutral",name:"Lawful Neutral",url:"/api/alignments/lawful-neutral"},{index:"lawful-evil",name:"Lawful Evil",url:"/api/alignments/lawful-evil"}]},{option_type:"ideal",desc:"Aspiration. I seek to prove myself worthy of my god's favor by matching my actions against his or her teachings.",alignments:[{index:"lawful-good",name:"Lawful Good",url:"/api/alignments/lawful-good"},{index:"neutral-good",name:"Neutral Good",url:"/api/alignments/neutral-good"},{index:"chaotic-good",name:"Chaotic Good",url:"/api/alignments/chaotic-good"},{index:"lawful-neutral",name:"Lawful Neutral",url:"/api/alignments/lawful-neutral"},{index:"neutral",name:"Neutral",url:"/api/alignments/neutral"},{index:"chaotic-neutral",name:"Chaotic Neutral",url:"/api/alignments/chaotic-neutral"},{index:"lawful-evil",name:"Lawful Evil",url:"/api/alignments/lawful-evil"},{index:"neutral-evil",name:"Neutral Evil",url:"/api/alignments/neutral-evil"},{index:"chaotic-evil",name:"Chaotic Evil",url:"/api/alignments/chaotic-evil"}]}]}},bonds:{choose:1,type:"bonds",from:{option_set_type:"options_array",options:[{option_type:"string",string:"I would die to recover an ancient relic of my faith that was lost long ago."},{option_type:"string",string:"I will someday get revenge on the corrupt temple hierarchy who branded me a heretic."},{option_type:"string",string:"I owe my life to the priest who took me in when my parents died."},{option_type:"string",string:"Everything I do is for the common people."},{option_type:"string",string:"I will do anything to protect the temple where I served."},{option_type:"string",string:"I seek to preserve a sacred text that my enemies consider heretical and seek to destroy."}]}},flaws:{choose:1,type:"flaws",from:{option_set_type:"options_array",options:[{option_type:"string",string:"I judge others harshly, and myself even more severely."},{option_type:"string",string:"I put too much trust in those who wield power within my temple's hierarchy."},{option_type:"string",string:"My piety sometimes leads me to blindly trust those that profess faith in my god."},{option_type:"string",string:"I am inflexible in my thinking."},{option_type:"string",string:"I am suspicious of strangers and expect the worst of them."},{option_type:"string",string:"Once I pick a goal, I become obsessed with it to the detriment of everything else in my life."}]}},url:"/api/backgrounds/acolyte"}}}}},method:"get",path:"/api/backgrounds/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a background by index.",description:{content:"# Background\n\nEvery story has a beginning. Your character's background reveals where you came from, how you became an adventurer, and your place in the world. Choosing a background provides you with important story cues about your character's identity. [[SRD p60](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=60)]\n\n_Note:_ acolyte is the only background included in the SRD.\n",type:"text/plain"},url:{path:["api","backgrounds",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the background to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-background-by-index",previous:{title:"Get an alignment by index.",permalink:"/docs/api/get-an-alignment-by-index"},next:{title:"Get a class by index.",permalink:"/docs/api/get-a-class-by-index"}},l=[];function c(e){const i={a:"a",code:"code",em:"em",h1:"h1",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-background-by-index",children:"Get a background by index."})}),"\n",(0,n.jsx)(i.h1,{id:"background",children:"Background"}),"\n",(0,n.jsxs)(i.p,{children:["Every story has a beginning. Your character's background reveals where you came from, how you became an adventurer, and your place in the world. Choosing a background provides you with important story cues about your character's identity. [",(0,n.jsx)(i.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=60",children:"SRD p60"}),"]"]}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.em,{children:"Note:"})," acolyte is the only background included in the SRD."]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"acolyte"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the background to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_proficiencies"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Starting proficiencies for all new characters of this background."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_equipment"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Starting equipment for all new characters of this background."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_equipment_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"language_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"feature"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Special feature granted to new characters of this background."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"personality_traits"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Choice of personality traits for this background."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ideals"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"bonds"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"flaws"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,o.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>s,x:()=>a});var n=t(96540);const o={},r=n.createContext(o);function s(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/90e0e748.8e4b0b5e.js b/assets/js/90e0e748.8e4b0b5e.js deleted file mode 100644 index 7ffcce4..0000000 --- a/assets/js/90e0e748.8e4b0b5e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5359],{273:(e,s,n)=>{n.r(s),n.d(s,{contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var t=n(74848),i=n(28453);const r={},l="Get list of all available resources for an endpoint.",o={type:"api",id:"get-list-of-all-available-resources-for-an-endpoint",title:"Get list of all available resources for an endpoint.",description:"",slug:"/get-list-of-all-available-resources-for-an-endpoint",frontMatter:{},api:{description:"Currently only the [`/spells`](#get-/api/spells) and [`/monsters`](#get-/api/monsters) endpoints support filtering with query parameters. Use of these query parameters is documented under the respective [Spells](#tag--Spells) and [Monsters](#tag--Monsters) sections.\n",tags:["Common"],parameters:[{name:"endpoint",in:"path",required:!0,schema:{type:"string",enum:["ability-scores","alignments","backgrounds","classes","conditions","damage-types","equipment","equipment-categories","feats","features","languages","magic-items","magic-schools","monsters","proficiencies","races","rule-sections","rules","skills","spells","subclasses","subraces","traits","weapon-properties"],example:"ability-scores"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},method:"get",path:"/api/{endpoint}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get list of all available resources for an endpoint.",description:{content:"Currently only the [`/spells`](#get-/api/spells) and [`/monsters`](#get-/api/monsters) endpoints support filtering with query parameters. Use of these query parameters is documented under the respective [Spells](#tag--Spells) and [Monsters](#tag--Monsters) sections.\n",type:"text/plain"},url:{path:["api",":endpoint"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"endpoint"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-list-of-all-available-resources-for-an-endpoint",previous:{title:"Get all resource URLs.",permalink:"/docs/api/get-all-resource-ur-ls"},next:{title:"Get an ability score by index.",permalink:"/docs/api/get-an-ability-score-by-index"}},c=[];function a(e){const s={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"get-list-of-all-available-resources-for-an-endpoint",children:"Get list of all available resources for an endpoint."})}),"\n",(0,t.jsxs)(s.p,{children:["Currently only the ",(0,t.jsx)(s.a,{href:"#get-/api/spells",children:(0,t.jsx)(s.code,{children:"/spells"})})," and ",(0,t.jsx)(s.a,{href:"#get-/api/monsters",children:(0,t.jsx)(s.code,{children:"/monsters"})})," endpoints support filtering with query parameters. Use of these query parameters is documented under the respective ",(0,t.jsx)(s.a,{href:"#tag--Spells",children:"Spells"})," and ",(0,t.jsx)(s.a,{href:"#tag--Monsters",children:"Monsters"})," sections."]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"endpoint"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"Possible values:"})," [",(0,t.jsx)(s.code,{children:"ability-scores"}),", ",(0,t.jsx)(s.code,{children:"alignments"}),", ",(0,t.jsx)(s.code,{children:"backgrounds"}),", ",(0,t.jsx)(s.code,{children:"classes"}),", ",(0,t.jsx)(s.code,{children:"conditions"}),", ",(0,t.jsx)(s.code,{children:"damage-types"}),", ",(0,t.jsx)(s.code,{children:"equipment"}),", ",(0,t.jsx)(s.code,{children:"equipment-categories"}),", ",(0,t.jsx)(s.code,{children:"feats"}),", ",(0,t.jsx)(s.code,{children:"features"}),", ",(0,t.jsx)(s.code,{children:"languages"}),", ",(0,t.jsx)(s.code,{children:"magic-items"}),", ",(0,t.jsx)(s.code,{children:"magic-schools"}),", ",(0,t.jsx)(s.code,{children:"monsters"}),", ",(0,t.jsx)(s.code,{children:"proficiencies"}),", ",(0,t.jsx)(s.code,{children:"races"}),", ",(0,t.jsx)(s.code,{children:"rule-sections"}),", ",(0,t.jsx)(s.code,{children:"rules"}),", ",(0,t.jsx)(s.code,{children:"skills"}),", ",(0,t.jsx)(s.code,{children:"spells"}),", ",(0,t.jsx)(s.code,{children:"subclasses"}),", ",(0,t.jsx)(s.code,{children:"subraces"}),", ",(0,t.jsx)(s.code,{children:"traits"}),", ",(0,t.jsx)(s.code,{children:"weapon-properties"}),"]"]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"count"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"results"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},28453:(e,s,n)=>{n.d(s,{R:()=>l,x:()=>o});var t=n(96540);const i={},r=t.createContext(i);function l(e){const s=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/90e0e748.c411dcd3.js b/assets/js/90e0e748.c411dcd3.js new file mode 100644 index 0000000..08d313b --- /dev/null +++ b/assets/js/90e0e748.c411dcd3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5359],{273:(e,s,t)=>{t.r(s),t.d(s,{contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var n=t(74848),i=t(28453);const r={},l="Get list of all available resources for an endpoint.",o={type:"api",id:"get-list-of-all-available-resources-for-an-endpoint",title:"Get list of all available resources for an endpoint.",description:"",slug:"/get-list-of-all-available-resources-for-an-endpoint",frontMatter:{},api:{description:"Currently only the [`/spells`](#get-/api/spells) and [`/monsters`](#get-/api/monsters) endpoints support filtering with query parameters. Use of these query parameters is documented under the respective [Spells](#tag--Spells) and [Monsters](#tag--Monsters) sections.\n",tags:["Common"],parameters:[{name:"endpoint",in:"path",required:!0,schema:{type:"string",enum:["ability-scores","alignments","backgrounds","classes","conditions","damage-types","equipment","equipment-categories","feats","features","languages","magic-items","magic-schools","monsters","proficiencies","races","rule-sections","rules","skills","spells","subclasses","subraces","traits","weapon-properties"],example:"ability-scores"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},method:"get",path:"/api/{endpoint}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get list of all available resources for an endpoint.",description:{content:"Currently only the [`/spells`](#get-/api/spells) and [`/monsters`](#get-/api/monsters) endpoints support filtering with query parameters. Use of these query parameters is documented under the respective [Spells](#tag--Spells) and [Monsters](#tag--Monsters) sections.\n",type:"text/plain"},url:{path:["api",":endpoint"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"endpoint"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-list-of-all-available-resources-for-an-endpoint",previous:{title:"Get all resource URLs.",permalink:"/docs/api/get-all-resource-ur-ls"},next:{title:"Get an ability score by index.",permalink:"/docs/api/get-an-ability-score-by-index"}},c=[];function a(e){const s={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"get-list-of-all-available-resources-for-an-endpoint",children:"Get list of all available resources for an endpoint."})}),"\n",(0,n.jsxs)(s.p,{children:["Currently only the ",(0,n.jsx)(s.a,{href:"#get-/api/spells",children:(0,n.jsx)(s.code,{children:"/spells"})})," and ",(0,n.jsx)(s.a,{href:"#get-/api/monsters",children:(0,n.jsx)(s.code,{children:"/monsters"})})," endpoints support filtering with query parameters. Use of these query parameters is documented under the respective ",(0,n.jsx)(s.a,{href:"#tag--Spells",children:"Spells"})," and ",(0,n.jsx)(s.a,{href:"#tag--Monsters",children:"Monsters"})," sections."]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"endpoint"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"Possible values:"})," [",(0,n.jsx)(s.code,{children:"ability-scores"}),", ",(0,n.jsx)(s.code,{children:"alignments"}),", ",(0,n.jsx)(s.code,{children:"backgrounds"}),", ",(0,n.jsx)(s.code,{children:"classes"}),", ",(0,n.jsx)(s.code,{children:"conditions"}),", ",(0,n.jsx)(s.code,{children:"damage-types"}),", ",(0,n.jsx)(s.code,{children:"equipment"}),", ",(0,n.jsx)(s.code,{children:"equipment-categories"}),", ",(0,n.jsx)(s.code,{children:"feats"}),", ",(0,n.jsx)(s.code,{children:"features"}),", ",(0,n.jsx)(s.code,{children:"languages"}),", ",(0,n.jsx)(s.code,{children:"magic-items"}),", ",(0,n.jsx)(s.code,{children:"magic-schools"}),", ",(0,n.jsx)(s.code,{children:"monsters"}),", ",(0,n.jsx)(s.code,{children:"proficiencies"}),", ",(0,n.jsx)(s.code,{children:"races"}),", ",(0,n.jsx)(s.code,{children:"rule-sections"}),", ",(0,n.jsx)(s.code,{children:"rules"}),", ",(0,n.jsx)(s.code,{children:"skills"}),", ",(0,n.jsx)(s.code,{children:"spells"}),", ",(0,n.jsx)(s.code,{children:"subclasses"}),", ",(0,n.jsx)(s.code,{children:"subraces"}),", ",(0,n.jsx)(s.code,{children:"traits"}),", ",(0,n.jsx)(s.code,{children:"weapon-properties"}),"]"]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"count"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"results"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,s,t)=>{t.d(s,{R:()=>l,x:()=>o});var n=t(96540);const i={},r=n.createContext(i);function l(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/944a6f01.841fe639.js b/assets/js/944a6f01.841fe639.js new file mode 100644 index 0000000..d98305e --- /dev/null +++ b/assets/js/944a6f01.841fe639.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[940],{61674:(e,i,s)=>{s.r(i),s.d(i,{contentTitle:()=>c,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>a});var r=s(74848),n=s(28453);const t={},c="Get proficiencies available for a class.",l={type:"api",id:"get-proficiencies-available-for-a-class",title:"Get proficiencies available for a class.",description:"",slug:"/get-proficiencies-available-for-a-class",frontMatter:{},api:{tags:["Class Resource Lists"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"List of proficiencies for the class.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get proficiencies available for a class.",method:"get",path:"/api/classes/{index}/proficiencies",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get proficiencies available for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","proficiencies"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-proficiencies-available-for-a-class",previous:{title:"Get features available for a class.",permalink:"/docs/api/get-features-available-for-a-class"},next:{title:"Get multiclassing resource for a class.",permalink:"/docs/api/get-multiclassing-resource-for-a-class"}},a=[];function o(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"get-proficiencies-available-for-a-class",children:"Get proficiencies available for a class."})}),"\n",(0,r.jsx)(i.p,{children:"Get proficiencies available for a class."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"Possible values:"})," [",(0,r.jsx)(i.code,{children:"barbarian"}),", ",(0,r.jsx)(i.code,{children:"bard"}),", ",(0,r.jsx)(i.code,{children:"cleric"}),", ",(0,r.jsx)(i.code,{children:"druid"}),", ",(0,r.jsx)(i.code,{children:"fighter"}),", ",(0,r.jsx)(i.code,{children:"monk"}),", ",(0,r.jsx)(i.code,{children:"paladin"}),", ",(0,r.jsx)(i.code,{children:"ranger"}),", ",(0,r.jsx)(i.code,{children:"rogue"}),", ",(0,r.jsx)(i.code,{children:"sorcerer"}),", ",(0,r.jsx)(i.code,{children:"warlock"}),", ",(0,r.jsx)(i.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:["The ",(0,r.jsx)(i.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(i.p,{children:"List of proficiencies for the class."})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,i,s)=>{s.d(i,{R:()=>c,x:()=>l});var r=s(96540);const n={},t=r.createContext(n);function c(e){const i=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),r.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/944a6f01.cd8ad998.js b/assets/js/944a6f01.cd8ad998.js deleted file mode 100644 index a7f5e4b..0000000 --- a/assets/js/944a6f01.cd8ad998.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[940],{61674:(e,i,s)=>{s.r(i),s.d(i,{contentTitle:()=>c,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>a});var r=s(74848),n=s(28453);const t={},c="Get proficiencies available for a class.",l={type:"api",id:"get-proficiencies-available-for-a-class",title:"Get proficiencies available for a class.",description:"",slug:"/get-proficiencies-available-for-a-class",frontMatter:{},api:{tags:["Class Resource Lists"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"List of proficiencies for the class.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get proficiencies available for a class.",method:"get",path:"/api/classes/{index}/proficiencies",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get proficiencies available for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","proficiencies"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-proficiencies-available-for-a-class",previous:{title:"Get features available for a class.",permalink:"/docs/api/get-features-available-for-a-class"},next:{title:"Get multiclassing resource for a class.",permalink:"/docs/api/get-multiclassing-resource-for-a-class"}},a=[];function o(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"get-proficiencies-available-for-a-class",children:"Get proficiencies available for a class."})}),"\n",(0,r.jsx)(i.p,{children:"Get proficiencies available for a class."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"Possible values:"})," [",(0,r.jsx)(i.code,{children:"barbarian"}),", ",(0,r.jsx)(i.code,{children:"bard"}),", ",(0,r.jsx)(i.code,{children:"cleric"}),", ",(0,r.jsx)(i.code,{children:"druid"}),", ",(0,r.jsx)(i.code,{children:"fighter"}),", ",(0,r.jsx)(i.code,{children:"monk"}),", ",(0,r.jsx)(i.code,{children:"paladin"}),", ",(0,r.jsx)(i.code,{children:"ranger"}),", ",(0,r.jsx)(i.code,{children:"rogue"}),", ",(0,r.jsx)(i.code,{children:"sorcerer"}),", ",(0,r.jsx)(i.code,{children:"warlock"}),", ",(0,r.jsx)(i.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:["The ",(0,r.jsx)(i.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(i.p,{children:"List of proficiencies for the class."})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,i,s)=>{s.d(i,{R:()=>c,x:()=>l});var r=s(96540);const n={},t=r.createContext(n);function c(e){const i=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),r.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/99171cef.2527c1c5.js b/assets/js/99171cef.2527c1c5.js deleted file mode 100644 index 3b70976..0000000 --- a/assets/js/99171cef.2527c1c5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5900],{31661:(e,n,i)=>{i.r(n),i.d(n,{contentTitle:()=>a,default:()=>c,frontMatter:()=>s,metadata:()=>l,toc:()=>o});var t=i(74848),r=i(28453);const s={},a="Get an alignment by index.",l={type:"api",id:"get-an-alignment-by-index",title:"Get an alignment by index.",description:"",slug:"/get-an-alignment-by-index",frontMatter:{},api:{description:"# Alignment\n\nA typical creature in the game world has an alignment, which broadly describes its moral and personal attitudes. Alignment is a combination of two factors: one identifies morality (good, evil, or neutral), and the other describes attitudes toward society and order (lawful, chaotic, or neutral). Thus, nine distinct alignments define the possible combinations.[[SRD p58](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=58)]\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the alignment to get.\n",schema:{type:"string",enum:["chaotic-neutral","chaotic-evil","chaotic-good","lawful-neutral","lawful-evil","lawful-good","neutral","neutral-evil","neutral-good"],example:"chaotic-neutral"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Alignment`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Brief description of the resource.",type:"string"},abbreviation:{description:"Abbreviation/initials/acronym for the alignment.",type:"string"}}},example:{index:"chaotic-neutral",name:"Chaotic Neutral",url:"/api/alignments/chaotic-neutral",desc:"Chaotic neutral (CN) creatures follow their whims, holding their personal freedom above all else. Many barbarians and rogues, and some bards, are chaotic neutral.",abbreviation:"CN"}}}}},method:"get",path:"/api/alignments/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get an alignment by index.",description:{content:"# Alignment\n\nA typical creature in the game world has an alignment, which broadly describes its moral and personal attitudes. Alignment is a combination of two factors: one identifies morality (good, evil, or neutral), and the other describes attitudes toward society and order (lawful, chaotic, or neutral). Thus, nine distinct alignments define the possible combinations.[[SRD p58](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=58)]\n",type:"text/plain"},url:{path:["api","alignments",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the alignment to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-an-alignment-by-index",previous:{title:"Get an ability score by index.",permalink:"/docs/api/get-an-ability-score-by-index"},next:{title:"Get a background by index.",permalink:"/docs/api/get-a-background-by-index"}},o=[];function d(e){const n={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"get-an-alignment-by-index",children:"Get an alignment by index."})}),"\n",(0,t.jsx)(n.h1,{id:"alignment",children:"Alignment"}),"\n",(0,t.jsxs)(n.p,{children:["A typical creature in the game world has an alignment, which broadly describes its moral and personal attitudes. Alignment is a combination of two factors: one identifies morality (good, evil, or neutral), and the other describes attitudes toward society and order (lawful, chaotic, or neutral). Thus, nine distinct alignments define the possible combinations.[",(0,t.jsx)(n.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=58",children:"SRD p58"}),"]"]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Possible values:"})," [",(0,t.jsx)(n.code,{children:"chaotic-neutral"}),", ",(0,t.jsx)(n.code,{children:"chaotic-evil"}),", ",(0,t.jsx)(n.code,{children:"chaotic-good"}),", ",(0,t.jsx)(n.code,{children:"lawful-neutral"}),", ",(0,t.jsx)(n.code,{children:"lawful-evil"}),", ",(0,t.jsx)(n.code,{children:"lawful-good"}),", ",(0,t.jsx)(n.code,{children:"neutral"}),", ",(0,t.jsx)(n.code,{children:"neutral-evil"}),", ",(0,t.jsx)(n.code,{children:"neutral-good"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"index"})," of the alignment to get."]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Brief description of the resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"abbreviation"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Abbreviation/initials/acronym for the alignment."})})]})})]})]})})]})})})]})]})}function c(e){void 0===e&&(e={});const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>l});var t=i(96540);const r={},s=t.createContext(r);function a(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/99171cef.44557f52.js b/assets/js/99171cef.44557f52.js new file mode 100644 index 0000000..d33920a --- /dev/null +++ b/assets/js/99171cef.44557f52.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5900],{31661:(e,n,i)=>{i.r(n),i.d(n,{contentTitle:()=>a,default:()=>c,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var t=i(74848),r=i(28453);const s={},a="Get an alignment by index.",o={type:"api",id:"get-an-alignment-by-index",title:"Get an alignment by index.",description:"",slug:"/get-an-alignment-by-index",frontMatter:{},api:{description:"# Alignment\n\nA typical creature in the game world has an alignment, which broadly describes its moral and personal attitudes. Alignment is a combination of two factors: one identifies morality (good, evil, or neutral), and the other describes attitudes toward society and order (lawful, chaotic, or neutral). Thus, nine distinct alignments define the possible combinations.[[SRD p58](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=58)]\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the alignment to get.\n",schema:{type:"string",enum:["chaotic-neutral","chaotic-evil","chaotic-good","lawful-neutral","lawful-evil","lawful-good","neutral","neutral-evil","neutral-good"],example:"chaotic-neutral"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Alignment`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Brief description of the resource.",type:"string"},abbreviation:{description:"Abbreviation/initials/acronym for the alignment.",type:"string"}}},example:{index:"chaotic-neutral",name:"Chaotic Neutral",url:"/api/alignments/chaotic-neutral",desc:"Chaotic neutral (CN) creatures follow their whims, holding their personal freedom above all else. Many barbarians and rogues, and some bards, are chaotic neutral.",abbreviation:"CN"}}}}},method:"get",path:"/api/alignments/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get an alignment by index.",description:{content:"# Alignment\n\nA typical creature in the game world has an alignment, which broadly describes its moral and personal attitudes. Alignment is a combination of two factors: one identifies morality (good, evil, or neutral), and the other describes attitudes toward society and order (lawful, chaotic, or neutral). Thus, nine distinct alignments define the possible combinations.[[SRD p58](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=58)]\n",type:"text/plain"},url:{path:["api","alignments",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the alignment to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-an-alignment-by-index",previous:{title:"Get an ability score by index.",permalink:"/docs/api/get-an-ability-score-by-index"},next:{title:"Get a background by index.",permalink:"/docs/api/get-a-background-by-index"}},l=[];function d(e){const n={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"get-an-alignment-by-index",children:"Get an alignment by index."})}),"\n",(0,t.jsx)(n.h1,{id:"alignment",children:"Alignment"}),"\n",(0,t.jsxs)(n.p,{children:["A typical creature in the game world has an alignment, which broadly describes its moral and personal attitudes. Alignment is a combination of two factors: one identifies morality (good, evil, or neutral), and the other describes attitudes toward society and order (lawful, chaotic, or neutral). Thus, nine distinct alignments define the possible combinations.[",(0,t.jsx)(n.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=58",children:"SRD p58"}),"]"]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Possible values:"})," [",(0,t.jsx)(n.code,{children:"chaotic-neutral"}),", ",(0,t.jsx)(n.code,{children:"chaotic-evil"}),", ",(0,t.jsx)(n.code,{children:"chaotic-good"}),", ",(0,t.jsx)(n.code,{children:"lawful-neutral"}),", ",(0,t.jsx)(n.code,{children:"lawful-evil"}),", ",(0,t.jsx)(n.code,{children:"lawful-good"}),", ",(0,t.jsx)(n.code,{children:"neutral"}),", ",(0,t.jsx)(n.code,{children:"neutral-evil"}),", ",(0,t.jsx)(n.code,{children:"neutral-good"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"index"})," of the alignment to get."]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Brief description of the resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"abbreviation"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(n.p,{children:"Abbreviation/initials/acronym for the alignment."})})]})})]})]})})]})})})]})]})}function c(e){void 0===e&&(e={});const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>o});var t=i(96540);const r={},s=t.createContext(r);function a(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9a539b0e.705d3c76.js b/assets/js/9a539b0e.705d3c76.js deleted file mode 100644 index 99ba881..0000000 --- a/assets/js/9a539b0e.705d3c76.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1621],{81486:(e,s,r)=>{r.r(s),r.d(s,{contentTitle:()=>t,default:()=>d,frontMatter:()=>l,metadata:()=>c,toc:()=>o});var i=r(74848),n=r(28453);const l={},t="Get level resource for a class and level.",c={type:"api",id:"get-level-resource-for-a-class-and-level",title:"Get level resource for a class and level.",description:"",slug:"/get-level-resource-for-a-class-and-level",frontMatter:{},api:{tags:["Class Levels"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}},{name:"class_level",in:"path",required:!0,schema:{type:"number",minimum:0,maximum:20,example:3}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`ClassLevel`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},level:{description:"The number value for the current level object.",type:"number"},ability_score_bonuses:{description:"Total number of ability score bonuses gained, added from previous levels.",type:"number"},prof_bonus:{description:"Proficiency bonus for this class at the specified level.",type:"number"},features:{description:"Features automatically gained at this level.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},spellcasting:{description:"Summary of spells known at this level.",type:"object",properties:{cantrips_known:{type:"number"},spells_known:{type:"number"},spell_slots_level_1:{type:"number"},spell_slots_level_2:{type:"number"},spell_slots_level_3:{type:"number"},spell_slots_level_4:{type:"number"},spell_slots_level_5:{type:"number"},spell_slots_level_6:{type:"number"},spell_slots_level_7:{type:"number"},spell_slots_level_8:{type:"number"},spell_slots_level_9:{type:"number"}}},class_specific:{description:"Class specific information such as dice values for bard songs and number of warlock invocations.",anyOf:[{description:"Barbarian Class Specific Features",type:"object",properties:{rage_count:{type:"number"},rage_damage_bonus:{type:"number"},brutal_critical_dice:{type:"number"}}},{description:"Bard Class Specific Features",type:"object",properties:{bardic_inspiration_dice:{type:"number"},song_of_rest_die:{type:"number"},magical_secrets_max_5:{type:"number"},magical_secrets_max_7:{type:"number"},magical_secrets_max_9:{type:"number"}}},{description:"Cleric Class Specific Features",type:"object",properties:{channel_divinity_charges:{type:"number"},destroy_undead_cr:{type:"number"}}},{description:"Druid Class Specific Features",type:"object",properties:{wild_shape_max_cr:{type:"number"},wild_shape_swim:{type:"boolean"},wild_shape_fly:{type:"boolean"}}},{description:"Fighter Class Specific Features",type:"object",properties:{action_surges:{type:"number"},indomitable_uses:{type:"number"},extra_attacks:{type:"number"}}},{description:"Monk Class Specific Features",type:"object",properties:{ki_points:{type:"number"},unarmored_movement:{type:"number"},martial_arts:{type:"object",properties:{dice_count:{type:"number"},dice_value:{type:"number"}}}}},{description:"Paladin Class Specific Features",type:"object",properties:{aura_range:{type:"number"}}},{description:"Bard Ranger Specific Features",type:"object",properties:{favored_enemies:{type:"number"},favored_terrain:{type:"number"}}},{description:"Bard Rogue Specific Features",type:"object",properties:{sneak_attack:{type:"object",properties:{dice_count:{type:"number"},dice_value:{type:"number"}}}}},{description:"Bard Sorcerer Specific Features",type:"object",properties:{sorcery_points:{type:"number"},metamagic_known:{type:"number"},creating_spell_slots:{type:"array",items:{type:"object",properties:{spell_slot_level:{type:"number"},sorcery_point_cost:{type:"number"}}}}}},{description:"Bard Warlock Specific Features",type:"object",properties:{invocations_known:{type:"number"},mystic_arcanum_level_6:{type:"number"},mystic_arcanum_level_7:{type:"number"},mystic_arcanum_level_8:{type:"number"},mystic_arcanum_level_9:{type:"number"}}},{description:"Wizard Class Specific Features",type:"object",properties:{arcane_recover_levels:{type:"number"}}}]}}},example:{level:1,ability_score_bonuses:0,prof_bonus:2,features:[{index:"rage",name:"Rage",url:"/api/features/rage"},{index:"barbarian-unarmored-defense",name:"Unarmored Defense",url:"/api/features/barbarian-unarmored-defense"}],class_specific:{rage_count:2,rage_damage_bonus:2,brutal_critical_dice:0},index:"barbarian-1",class:{index:"barbarian",name:"Barbarian",url:"/api/classes/barbarian"},url:"/api/classes/barbarian/levels/1"}}}}},description:"Get level resource for a class and level.",method:"get",path:"/api/classes/{index}/levels/{class_level}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get level resource for a class and level.",description:{type:"text/plain"},url:{path:["api","classes",":index","levels",":class_level"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"},{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"class_level"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-level-resource-for-a-class-and-level",previous:{title:"Get all level resources for a class.",permalink:"/docs/api/get-all-level-resources-for-a-class"},next:{title:"Get features available to a class at the requested level.",permalink:"/docs/api/get-features-available-to-a-class-at-the-requested-level"}},o=[];function a(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"get-level-resource-for-a-class-and-level",children:"Get level resource for a class and level."})}),"\n",(0,i.jsx)(s.p,{children:"Get level resource for a class and level."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," [",(0,i.jsx)(s.code,{children:"barbarian"}),", ",(0,i.jsx)(s.code,{children:"bard"}),", ",(0,i.jsx)(s.code,{children:"cleric"}),", ",(0,i.jsx)(s.code,{children:"druid"}),", ",(0,i.jsx)(s.code,{children:"fighter"}),", ",(0,i.jsx)(s.code,{children:"monk"}),", ",(0,i.jsx)(s.code,{children:"paladin"}),", ",(0,i.jsx)(s.code,{children:"ranger"}),", ",(0,i.jsx)(s.code,{children:"rogue"}),", ",(0,i.jsx)(s.code,{children:"sorcerer"}),", ",(0,i.jsx)(s.code,{children:"warlock"}),", ",(0,i.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"index"})," of the class to get."]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"class_level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," value \u2264 20"]})})]})})]})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"The number value for the current level object."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"ability_score_bonuses"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Total number of ability score bonuses gained, added from previous levels."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"prof_bonus"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Proficiency bonus for this class at the specified level."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"features"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Features automatically gained at this level."})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spellcasting"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Summary of spells known at this level."})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"cantrips_known"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spells_known"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_1"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_2"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_3"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_4"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_5"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_6"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_7"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_8"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_9"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"class_specific"}),(0,i.jsx)("span",{style:{opacity:"0.6"}}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Class specific information such as dice values for bard songs and number of warlock invocations."})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},28453:(e,s,r)=>{r.d(s,{R:()=>t,x:()=>c});var i=r(96540);const n={},l=i.createContext(n);function t(e){const s=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:t(e.components),i.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9a539b0e.e4c3d27b.js b/assets/js/9a539b0e.e4c3d27b.js new file mode 100644 index 0000000..258799c --- /dev/null +++ b/assets/js/9a539b0e.e4c3d27b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1621],{81486:(e,s,r)=>{r.r(s),r.d(s,{contentTitle:()=>t,default:()=>d,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var i=r(74848),n=r(28453);const l={},t="Get level resource for a class and level.",o={type:"api",id:"get-level-resource-for-a-class-and-level",title:"Get level resource for a class and level.",description:"",slug:"/get-level-resource-for-a-class-and-level",frontMatter:{},api:{tags:["Class Levels"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}},{name:"class_level",in:"path",required:!0,schema:{type:"number",minimum:0,maximum:20,example:3}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`ClassLevel`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},level:{description:"The number value for the current level object.",type:"number"},ability_score_bonuses:{description:"Total number of ability score bonuses gained, added from previous levels.",type:"number"},prof_bonus:{description:"Proficiency bonus for this class at the specified level.",type:"number"},features:{description:"Features automatically gained at this level.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},spellcasting:{description:"Summary of spells known at this level.",type:"object",properties:{cantrips_known:{type:"number"},spells_known:{type:"number"},spell_slots_level_1:{type:"number"},spell_slots_level_2:{type:"number"},spell_slots_level_3:{type:"number"},spell_slots_level_4:{type:"number"},spell_slots_level_5:{type:"number"},spell_slots_level_6:{type:"number"},spell_slots_level_7:{type:"number"},spell_slots_level_8:{type:"number"},spell_slots_level_9:{type:"number"}}},class_specific:{description:"Class specific information such as dice values for bard songs and number of warlock invocations.",anyOf:[{description:"Barbarian Class Specific Features",type:"object",properties:{rage_count:{type:"number"},rage_damage_bonus:{type:"number"},brutal_critical_dice:{type:"number"}}},{description:"Bard Class Specific Features",type:"object",properties:{bardic_inspiration_dice:{type:"number"},song_of_rest_die:{type:"number"},magical_secrets_max_5:{type:"number"},magical_secrets_max_7:{type:"number"},magical_secrets_max_9:{type:"number"}}},{description:"Cleric Class Specific Features",type:"object",properties:{channel_divinity_charges:{type:"number"},destroy_undead_cr:{type:"number"}}},{description:"Druid Class Specific Features",type:"object",properties:{wild_shape_max_cr:{type:"number"},wild_shape_swim:{type:"boolean"},wild_shape_fly:{type:"boolean"}}},{description:"Fighter Class Specific Features",type:"object",properties:{action_surges:{type:"number"},indomitable_uses:{type:"number"},extra_attacks:{type:"number"}}},{description:"Monk Class Specific Features",type:"object",properties:{ki_points:{type:"number"},unarmored_movement:{type:"number"},martial_arts:{type:"object",properties:{dice_count:{type:"number"},dice_value:{type:"number"}}}}},{description:"Paladin Class Specific Features",type:"object",properties:{aura_range:{type:"number"}}},{description:"Bard Ranger Specific Features",type:"object",properties:{favored_enemies:{type:"number"},favored_terrain:{type:"number"}}},{description:"Bard Rogue Specific Features",type:"object",properties:{sneak_attack:{type:"object",properties:{dice_count:{type:"number"},dice_value:{type:"number"}}}}},{description:"Bard Sorcerer Specific Features",type:"object",properties:{sorcery_points:{type:"number"},metamagic_known:{type:"number"},creating_spell_slots:{type:"array",items:{type:"object",properties:{spell_slot_level:{type:"number"},sorcery_point_cost:{type:"number"}}}}}},{description:"Bard Warlock Specific Features",type:"object",properties:{invocations_known:{type:"number"},mystic_arcanum_level_6:{type:"number"},mystic_arcanum_level_7:{type:"number"},mystic_arcanum_level_8:{type:"number"},mystic_arcanum_level_9:{type:"number"}}},{description:"Wizard Class Specific Features",type:"object",properties:{arcane_recover_levels:{type:"number"}}}]}}},example:{level:1,ability_score_bonuses:0,prof_bonus:2,features:[{index:"rage",name:"Rage",url:"/api/features/rage"},{index:"barbarian-unarmored-defense",name:"Unarmored Defense",url:"/api/features/barbarian-unarmored-defense"}],class_specific:{rage_count:2,rage_damage_bonus:2,brutal_critical_dice:0},index:"barbarian-1",class:{index:"barbarian",name:"Barbarian",url:"/api/classes/barbarian"},url:"/api/classes/barbarian/levels/1"}}}}},description:"Get level resource for a class and level.",method:"get",path:"/api/classes/{index}/levels/{class_level}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get level resource for a class and level.",description:{type:"text/plain"},url:{path:["api","classes",":index","levels",":class_level"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"},{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"class_level"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-level-resource-for-a-class-and-level",previous:{title:"Get all level resources for a class.",permalink:"/docs/api/get-all-level-resources-for-a-class"},next:{title:"Get features available to a class at the requested level.",permalink:"/docs/api/get-features-available-to-a-class-at-the-requested-level"}},c=[];function a(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"get-level-resource-for-a-class-and-level",children:"Get level resource for a class and level."})}),"\n",(0,i.jsx)(s.p,{children:"Get level resource for a class and level."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," [",(0,i.jsx)(s.code,{children:"barbarian"}),", ",(0,i.jsx)(s.code,{children:"bard"}),", ",(0,i.jsx)(s.code,{children:"cleric"}),", ",(0,i.jsx)(s.code,{children:"druid"}),", ",(0,i.jsx)(s.code,{children:"fighter"}),", ",(0,i.jsx)(s.code,{children:"monk"}),", ",(0,i.jsx)(s.code,{children:"paladin"}),", ",(0,i.jsx)(s.code,{children:"ranger"}),", ",(0,i.jsx)(s.code,{children:"rogue"}),", ",(0,i.jsx)(s.code,{children:"sorcerer"}),", ",(0,i.jsx)(s.code,{children:"warlock"}),", ",(0,i.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"index"})," of the class to get."]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"class_level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," value \u2264 20"]})})]})})]})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"The number value for the current level object."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"ability_score_bonuses"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Total number of ability score bonuses gained, added from previous levels."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"prof_bonus"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Proficiency bonus for this class at the specified level."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"features"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Features automatically gained at this level."})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spellcasting"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Summary of spells known at this level."})}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"cantrips_known"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spells_known"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_1"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_2"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_3"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_4"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_5"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_6"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_7"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_8"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"spell_slots_level_9"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"class_specific"}),(0,i.jsx)("span",{style:{opacity:"0.6"}}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Class specific information such as dice values for bard songs and number of warlock invocations."})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},28453:(e,s,r)=>{r.d(s,{R:()=>t,x:()=>o});var i=r(96540);const n={},l=i.createContext(n);function t(e){const s=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:t(e.components),i.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9c8fcee4.2ca4f91c.js b/assets/js/9c8fcee4.2ca4f91c.js new file mode 100644 index 0000000..cb45797 --- /dev/null +++ b/assets/js/9c8fcee4.2ca4f91c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5850],{15074:(e,s,l)=>{l.r(s),l.d(s,{contentTitle:()=>n,default:()=>d,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var i=l(74848),r=l(28453);const t={},n="Get spells available for a class.",a={type:"api",id:"get-spells-available-for-a-class",title:"Get spells available for a class.",description:"",slug:"/get-spells-available-for-a-class",frontMatter:{},api:{tags:["Class Resource Lists"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`ClassSpellList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`ClassLevelSpell`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},level:{type:"number",description:"The level of the spell slot used to cast the spell."}}}}}},example:{count:2,results:[{index:"power-word-kill",name:"Power Word Kill",url:"/api/spells/power-word-kill",level:9},{index:"true-polymorph",name:"True Polymorph",url:"/api/spells/true-polymorph",level:9}]}}}}},description:"Get spells available for a class.",method:"get",path:"/api/classes/{index}/spells",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get spells available for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","spells"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-spells-available-for-a-class",previous:{title:"Get subclasses available for a class.",permalink:"/docs/api/get-subclasses-available-for-a-class"},next:{title:"Get spellcasting info for a class.",permalink:"/docs/api/get-spellcasting-info-for-a-class"}},o=[];function c(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"get-spells-available-for-a-class",children:"Get spells available for a class."})}),"\n",(0,i.jsx)(s.p,{children:"Get spells available for a class."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"Possible values:"})," [",(0,i.jsx)(s.code,{children:"barbarian"}),", ",(0,i.jsx)(s.code,{children:"bard"}),", ",(0,i.jsx)(s.code,{children:"cleric"}),", ",(0,i.jsx)(s.code,{children:"druid"}),", ",(0,i.jsx)(s.code,{children:"fighter"}),", ",(0,i.jsx)(s.code,{children:"monk"}),", ",(0,i.jsx)(s.code,{children:"paladin"}),", ",(0,i.jsx)(s.code,{children:"ranger"}),", ",(0,i.jsx)(s.code,{children:"rogue"}),", ",(0,i.jsx)(s.code,{children:"sorcerer"}),", ",(0,i.jsx)(s.code,{children:"warlock"}),", ",(0,i.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"count"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"results"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(s.p,{children:"The level of the spell slot used to cast the spell."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},28453:(e,s,l)=>{l.d(s,{R:()=>n,x:()=>a});var i=l(96540);const r={},t=i.createContext(r);function n(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:n(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9c8fcee4.4143778e.js b/assets/js/9c8fcee4.4143778e.js deleted file mode 100644 index 939d56a..0000000 --- a/assets/js/9c8fcee4.4143778e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5850],{15074:(e,s,i)=>{i.r(s),i.d(s,{contentTitle:()=>t,default:()=>d,frontMatter:()=>n,metadata:()=>a,toc:()=>c});var r=i(74848),l=i(28453);const n={},t="Get spells available for a class.",a={type:"api",id:"get-spells-available-for-a-class",title:"Get spells available for a class.",description:"",slug:"/get-spells-available-for-a-class",frontMatter:{},api:{tags:["Class Resource Lists"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{count:2,results:[{index:"power-word-kill",level:9,name:"Power Word Kill",url:"/api/spells/power-word-kill"},{index:"true-polymorph",level:9,name:"True Polymorph",url:"/api/spells/true-polymorph"}]}}}}},description:"Get spells available for a class.",method:"get",path:"/api/classes/{index}/spells",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get spells available for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","spells"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-spells-available-for-a-class",previous:{title:"Get subclasses available for a class.",permalink:"/docs/api/get-subclasses-available-for-a-class"},next:{title:"Get spellcasting info for a class.",permalink:"/docs/api/get-spellcasting-info-for-a-class"}},c=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"get-spells-available-for-a-class",children:"Get spells available for a class."})}),"\n",(0,r.jsx)(s.p,{children:"Get spells available for a class."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," [",(0,r.jsx)(s.code,{children:"barbarian"}),", ",(0,r.jsx)(s.code,{children:"bard"}),", ",(0,r.jsx)(s.code,{children:"cleric"}),", ",(0,r.jsx)(s.code,{children:"druid"}),", ",(0,r.jsx)(s.code,{children:"fighter"}),", ",(0,r.jsx)(s.code,{children:"monk"}),", ",(0,r.jsx)(s.code,{children:"paladin"}),", ",(0,r.jsx)(s.code,{children:"ranger"}),", ",(0,r.jsx)(s.code,{children:"rogue"}),", ",(0,r.jsx)(s.code,{children:"sorcerer"}),", ",(0,r.jsx)(s.code,{children:"warlock"}),", ",(0,r.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,l.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,s,i)=>{i.d(s,{R:()=>t,x:()=>a});var r=i(96540);const l={},n=r.createContext(l);function t(e){const s=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:t(e.components),r.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a8dfb490.0a88ca81.js b/assets/js/a8dfb490.0a88ca81.js new file mode 100644 index 0000000..3b93428 --- /dev/null +++ b/assets/js/a8dfb490.0a88ca81.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3359],{48088:(e,s,t)=>{t.r(s),t.d(s,{contentTitle:()=>r,default:()=>c,frontMatter:()=>n,metadata:()=>a,toc:()=>d});var l=t(74848),i=t(28453);const n={},r="Get spells of the requested level available to the class.",a={type:"api",id:"get-spells-of-the-requested-level-available-to-the-class",title:"Get spells of the requested level available to the class.",description:"",slug:"/get-spells-of-the-requested-level-available-to-the-class",frontMatter:{},api:{tags:["Class Levels"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}},{name:"spell_level",in:"path",required:!0,schema:{type:"number",minimum:1,maximum:9,example:4}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{count:5,results:[{index:"dominate-monster",name:"Dominate Monster",url:"/api/spells/dominate-monster"},{index:"earthquake",name:"Earthquake",url:"/api/spells/earthquake"},{index:"incendiary-cloud",name:"Incendiary Cloud",url:"/api/spells/incendiary-cloud"},{index:"power-word-stun",name:"Power Word Stun",url:"/api/spells/power-word-stun"},{index:"sunburst",name:"Sunburst",url:"/api/spells/sunburst"}]}}}}},description:"Get spells of the requested level available to the class.",method:"get",path:"/api/classes/{index}/levels/{spell_level}/spells",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get spells of the requested level available to the class.",description:{type:"text/plain"},url:{path:["api","classes",":index","levels",":spell_level","spells"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"},{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"spell_level"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-spells-of-the-requested-level-available-to-the-class",previous:{title:"Get features available to a class at the requested level.",permalink:"/docs/api/get-features-available-to-a-class-at-the-requested-level"},next:{title:"Get a condition by index.",permalink:"/docs/api/get-a-condition-by-index"}},d=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(s.header,{children:(0,l.jsx)(s.h1,{id:"get-spells-of-the-requested-level-available-to-the-class",children:"Get spells of the requested level available to the class."})}),"\n",(0,l.jsx)(s.p,{children:"Get spells of the requested level available to the class."}),"\n",(0,l.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"index"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Possible values:"})," [",(0,l.jsx)(s.code,{children:"barbarian"}),", ",(0,l.jsx)(s.code,{children:"bard"}),", ",(0,l.jsx)(s.code,{children:"cleric"}),", ",(0,l.jsx)(s.code,{children:"druid"}),", ",(0,l.jsx)(s.code,{children:"fighter"}),", ",(0,l.jsx)(s.code,{children:"monk"}),", ",(0,l.jsx)(s.code,{children:"paladin"}),", ",(0,l.jsx)(s.code,{children:"ranger"}),", ",(0,l.jsx)(s.code,{children:"rogue"}),", ",(0,l.jsx)(s.code,{children:"sorcerer"}),", ",(0,l.jsx)(s.code,{children:"warlock"}),", ",(0,l.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:["The ",(0,l.jsx)(s.code,{children:"index"})," of the class to get."]})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"spell_level"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Possible values:"})," 1 \u2264 value \u2264 9"]})})]})})]})]}),"\n",(0,l.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,l.jsx)("tbody",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsxs)("div",{style:{display:"flex"},children:[(0,l.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)("code",{children:"200"})}),(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"OK"})})]}),(0,l.jsx)("div",{children:(0,l.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("th",{style:{textAlign:"left"},children:[(0,l.jsx)("span",{children:"Schema "}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{})]})})}),(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"count"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"results"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"index"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"name"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"url"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function c(e){void 0===e&&(e={});const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},28453:(e,s,t)=>{t.d(s,{R:()=>r,x:()=>a});var l=t(96540);const i={},n=l.createContext(i);function r(e){const s=l.useContext(n);return l.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),l.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a8dfb490.0d8a99fd.js b/assets/js/a8dfb490.0d8a99fd.js deleted file mode 100644 index c926d27..0000000 --- a/assets/js/a8dfb490.0d8a99fd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3359],{48088:(e,s,l)=>{l.r(s),l.d(s,{contentTitle:()=>r,default:()=>c,frontMatter:()=>n,metadata:()=>a,toc:()=>d});var t=l(74848),i=l(28453);const n={},r="Get spells of the requested level available to the class.",a={type:"api",id:"get-spells-of-the-requested-level-available-to-the-class",title:"Get spells of the requested level available to the class.",description:"",slug:"/get-spells-of-the-requested-level-available-to-the-class",frontMatter:{},api:{tags:["Class Levels"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}},{name:"spell_level",in:"path",required:!0,schema:{type:"number",minimum:1,maximum:9,example:4}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{count:5,results:[{index:"dominate-monster",level:8,name:"Dominate Monster",url:"/api/spells/dominate-monster"},{index:"earthquake",level:8,name:"Earthquake",url:"/api/spells/earthquake"},{index:"incendiary-cloud",level:8,name:"Incendiary Cloud",url:"/api/spells/incendiary-cloud"},{index:"power-word-stun",level:8,name:"Power Word Stun",url:"/api/spells/power-word-stun"},{index:"sunburst",level:8,name:"Sunburst",url:"/api/spells/sunburst"}]}}}}},description:"Get spells of the requested level available to the class.",method:"get",path:"/api/classes/{index}/levels/{spell_level}/spells",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get spells of the requested level available to the class.",description:{type:"text/plain"},url:{path:["api","classes",":index","levels",":spell_level","spells"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"},{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"spell_level"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-spells-of-the-requested-level-available-to-the-class",previous:{title:"Get features available to a class at the requested level.",permalink:"/docs/api/get-features-available-to-a-class-at-the-requested-level"},next:{title:"Get a condition by index.",permalink:"/docs/api/get-a-condition-by-index"}},d=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"get-spells-of-the-requested-level-available-to-the-class",children:"Get spells of the requested level available to the class."})}),"\n",(0,t.jsx)(s.p,{children:"Get spells of the requested level available to the class."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"Possible values:"})," [",(0,t.jsx)(s.code,{children:"barbarian"}),", ",(0,t.jsx)(s.code,{children:"bard"}),", ",(0,t.jsx)(s.code,{children:"cleric"}),", ",(0,t.jsx)(s.code,{children:"druid"}),", ",(0,t.jsx)(s.code,{children:"fighter"}),", ",(0,t.jsx)(s.code,{children:"monk"}),", ",(0,t.jsx)(s.code,{children:"paladin"}),", ",(0,t.jsx)(s.code,{children:"ranger"}),", ",(0,t.jsx)(s.code,{children:"rogue"}),", ",(0,t.jsx)(s.code,{children:"sorcerer"}),", ",(0,t.jsx)(s.code,{children:"warlock"}),", ",(0,t.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(s.p,{children:["The ",(0,t.jsx)(s.code,{children:"index"})," of the class to get."]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"spell_level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"Possible values:"})," 1 \u2264 value \u2264 9"]})})]})})]})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"count"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"results"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function c(e){void 0===e&&(e={});const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},28453:(e,s,l)=>{l.d(s,{R:()=>r,x:()=>a});var t=l(96540);const i={},n=t.createContext(i);function r(e){const s=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ae15d4dd.737f2726.js b/assets/js/ae15d4dd.737f2726.js deleted file mode 100644 index 150ba3e..0000000 --- a/assets/js/ae15d4dd.737f2726.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4243],{15254:(e,i,n)=>{n.r(i),n.d(i,{contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var s=n(74848),t=n(28453);const r={},l="Get a skill by index.",c={type:"api",id:"get-a-skill-by-index",title:"Get a skill by index.",description:"",slug:"/get-a-skill-by-index",frontMatter:{},api:{description:"# Skill\n\nEach ability covers a broad range of capabilities, including skills that a character or a monster can be proficient in. A skill represents a specific aspect of an ability score, and an individual's proficiency in a skill demonstrates a focus on that aspect. [[SRD p77](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=77)]\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the skill to get.\n",schema:{type:"string",enum:["acrobatics","animal-handling","arcana","athletics","deception","history","insight","intimidation","investigation","medicine","nature","perception","performance","persuasion","religion","sleight-of-hand","stealth","survival"],example:"nature"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Skill`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},example:{index:"acrobatics",name:"Acrobatics",url:"/api/skills/acrobatics",ability_score:{index:"dex",name:"DEX",url:"/api/ability-scores/dex"},desc:["Your Dexterity (Acrobatics) check covers your attempt to stay on your feet in a tricky situation, such as when you're trying to run across a sheet of ice, balance on a tightrope, or stay upright on a rocking ship's deck. The GM might also call for a Dexterity (Acrobatics) check to see if you can perform acrobatic stunts, including dives, rolls, somersaults, and flips."]}}}}},method:"get",path:"/api/skills/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a skill by index.",description:{content:"# Skill\n\nEach ability covers a broad range of capabilities, including skills that a character or a monster can be proficient in. A skill represents a specific aspect of an ability score, and an individual's proficiency in a skill demonstrates a focus on that aspect. [[SRD p77](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=77)]\n",type:"text/plain"},url:{path:["api","skills",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the skill to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-skill-by-index",previous:{title:"Get a rule by index.",permalink:"/docs/api/get-a-rule-by-index"},next:{title:"Get list of spells with optional filtering.",permalink:"/docs/api/get-list-of-spells-with-optional-filtering"}},o=[];function a(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"get-a-skill-by-index",children:"Get a skill by index."})}),"\n",(0,s.jsx)(i.h1,{id:"skill",children:"Skill"}),"\n",(0,s.jsxs)(i.p,{children:["Each ability covers a broad range of capabilities, including skills that a character or a monster can be proficient in. A skill represents a specific aspect of an ability score, and an individual's proficiency in a skill demonstrates a focus on that aspect. [",(0,s.jsx)(i.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=77",children:"SRD p77"}),"]"]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"Possible values:"})," [",(0,s.jsx)(i.code,{children:"acrobatics"}),", ",(0,s.jsx)(i.code,{children:"animal-handling"}),", ",(0,s.jsx)(i.code,{children:"arcana"}),", ",(0,s.jsx)(i.code,{children:"athletics"}),", ",(0,s.jsx)(i.code,{children:"deception"}),", ",(0,s.jsx)(i.code,{children:"history"}),", ",(0,s.jsx)(i.code,{children:"insight"}),", ",(0,s.jsx)(i.code,{children:"intimidation"}),", ",(0,s.jsx)(i.code,{children:"investigation"}),", ",(0,s.jsx)(i.code,{children:"medicine"}),", ",(0,s.jsx)(i.code,{children:"nature"}),", ",(0,s.jsx)(i.code,{children:"perception"}),", ",(0,s.jsx)(i.code,{children:"performance"}),", ",(0,s.jsx)(i.code,{children:"persuasion"}),", ",(0,s.jsx)(i.code,{children:"religion"}),", ",(0,s.jsx)(i.code,{children:"sleight-of-hand"}),", ",(0,s.jsx)(i.code,{children:"stealth"}),", ",(0,s.jsx)(i.code,{children:"survival"}),"]"]})}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(i.p,{children:["The ",(0,s.jsx)(i.code,{children:"index"})," of the skill to get."]})})]})})})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsxs)("div",{style:{display:"flex"},children:[(0,s.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)("code",{children:"200"})}),(0,s.jsx)("div",{children:(0,s.jsx)(i.p,{children:"OK"})})]}),(0,s.jsx)("div",{children:(0,s.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Schema "}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{})]})})}),(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"level"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"desc"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"ability_score"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:(0,s.jsx)(i.code,{children:"APIReference"})})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"level"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},28453:(e,i,n)=>{n.d(i,{R:()=>l,x:()=>c});var s=n(96540);const t={},r=s.createContext(t);function l(e){const i=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),s.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ae15d4dd.8df9d1f2.js b/assets/js/ae15d4dd.8df9d1f2.js new file mode 100644 index 0000000..00ba9ca --- /dev/null +++ b/assets/js/ae15d4dd.8df9d1f2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4243],{15254:(e,i,n)=>{n.r(i),n.d(i,{contentTitle:()=>c,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>a});var s=n(74848),t=n(28453);const r={},c="Get a skill by index.",l={type:"api",id:"get-a-skill-by-index",title:"Get a skill by index.",description:"",slug:"/get-a-skill-by-index",frontMatter:{},api:{description:"# Skill\n\nEach ability covers a broad range of capabilities, including skills that a character or a monster can be proficient in. A skill represents a specific aspect of an ability score, and an individual's proficiency in a skill demonstrates a focus on that aspect. [[SRD p77](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=77)]\n",tags:["Character Data"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the skill to get.\n",schema:{type:"string",enum:["acrobatics","animal-handling","arcana","athletics","deception","history","insight","intimidation","investigation","medicine","nature","perception","performance","persuasion","religion","sleight-of-hand","stealth","survival"],example:"nature"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Skill`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},example:{index:"acrobatics",name:"Acrobatics",url:"/api/skills/acrobatics",ability_score:{index:"dex",name:"DEX",url:"/api/ability-scores/dex"},desc:["Your Dexterity (Acrobatics) check covers your attempt to stay on your feet in a tricky situation, such as when you're trying to run across a sheet of ice, balance on a tightrope, or stay upright on a rocking ship's deck. The GM might also call for a Dexterity (Acrobatics) check to see if you can perform acrobatic stunts, including dives, rolls, somersaults, and flips."]}}}}},method:"get",path:"/api/skills/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a skill by index.",description:{content:"# Skill\n\nEach ability covers a broad range of capabilities, including skills that a character or a monster can be proficient in. A skill represents a specific aspect of an ability score, and an individual's proficiency in a skill demonstrates a focus on that aspect. [[SRD p77](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=77)]\n",type:"text/plain"},url:{path:["api","skills",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the skill to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-skill-by-index",previous:{title:"Get a rule by index.",permalink:"/docs/api/get-a-rule-by-index"},next:{title:"Get list of spells with optional filtering.",permalink:"/docs/api/get-list-of-spells-with-optional-filtering"}},a=[];function o(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"get-a-skill-by-index",children:"Get a skill by index."})}),"\n",(0,s.jsx)(i.h1,{id:"skill",children:"Skill"}),"\n",(0,s.jsxs)(i.p,{children:["Each ability covers a broad range of capabilities, including skills that a character or a monster can be proficient in. A skill represents a specific aspect of an ability score, and an individual's proficiency in a skill demonstrates a focus on that aspect. [",(0,s.jsx)(i.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=77",children:"SRD p77"}),"]"]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"Possible values:"})," [",(0,s.jsx)(i.code,{children:"acrobatics"}),", ",(0,s.jsx)(i.code,{children:"animal-handling"}),", ",(0,s.jsx)(i.code,{children:"arcana"}),", ",(0,s.jsx)(i.code,{children:"athletics"}),", ",(0,s.jsx)(i.code,{children:"deception"}),", ",(0,s.jsx)(i.code,{children:"history"}),", ",(0,s.jsx)(i.code,{children:"insight"}),", ",(0,s.jsx)(i.code,{children:"intimidation"}),", ",(0,s.jsx)(i.code,{children:"investigation"}),", ",(0,s.jsx)(i.code,{children:"medicine"}),", ",(0,s.jsx)(i.code,{children:"nature"}),", ",(0,s.jsx)(i.code,{children:"perception"}),", ",(0,s.jsx)(i.code,{children:"performance"}),", ",(0,s.jsx)(i.code,{children:"persuasion"}),", ",(0,s.jsx)(i.code,{children:"religion"}),", ",(0,s.jsx)(i.code,{children:"sleight-of-hand"}),", ",(0,s.jsx)(i.code,{children:"stealth"}),", ",(0,s.jsx)(i.code,{children:"survival"}),"]"]})}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsxs)(i.p,{children:["The ",(0,s.jsx)(i.code,{children:"index"})," of the skill to get."]})})]})})})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsxs)("div",{style:{display:"flex"},children:[(0,s.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)("code",{children:"200"})}),(0,s.jsx)("div",{children:(0,s.jsx)(i.p,{children:"OK"})})]}),(0,s.jsx)("div",{children:(0,s.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Schema "}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{})]})})}),(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"desc"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"ability_score"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:(0,s.jsx)(i.code,{children:"APIReference"})})}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"index"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"url"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},28453:(e,i,n)=>{n.d(i,{R:()=>c,x:()=>l});var s=n(96540);const t={},r=s.createContext(t);function c(e){const i=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b2a6176d.4d0bdadd.js b/assets/js/b2a6176d.4d0bdadd.js deleted file mode 100644 index ff586ff..0000000 --- a/assets/js/b2a6176d.4d0bdadd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5884],{55:(e,s,t)=>{t.r(s),t.d(s,{contentTitle:()=>r,default:()=>d,frontMatter:()=>n,metadata:()=>a,toc:()=>c});var l=t(74848),i=t(28453);const n={},r="Get features of the requested spell level available to the class.",a={type:"api",id:"get-features-of-the-requested-spell-level-available-to-the-class",title:"Get features of the requested spell level available to the class.",description:"",slug:"/get-features-of-the-requested-spell-level-available-to-the-class",frontMatter:{},api:{tags:["Subclasses"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subclass to get.\n",schema:{type:"string",enum:["berserker","champion","devotion","draconic","evocation","fiend","hunter","land","life","lore","open-hand","thief"],example:"fiend"}},{name:"subclass_level",in:"path",required:!0,schema:{type:"integer",minimum:0,maximum:20},example:6}],responses:{200:{description:"List of features for the subclass and level.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get features of the requested spell level available to the class.",method:"get",path:"/api/subclasses/{index}/levels/{subclass_level}/features",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get features of the requested spell level available to the class.",description:{type:"text/plain"},url:{path:["api","subclasses",":index","levels",":subclass_level","features"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subclass to get.\n",type:"text/plain"},type:"any",value:"",key:"index"},{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"subclass_level"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-features-of-the-requested-spell-level-available-to-the-class",previous:{title:"Get level resources for a subclass and level.",permalink:"/docs/api/get-level-resources-for-a-subclass-and-level"},next:{title:"Get a subrace by index.",permalink:"/docs/api/get-a-subrace-by-index"}},c=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(s.header,{children:(0,l.jsx)(s.h1,{id:"get-features-of-the-requested-spell-level-available-to-the-class",children:"Get features of the requested spell level available to the class."})}),"\n",(0,l.jsx)(s.p,{children:"Get features of the requested spell level available to the class."}),"\n",(0,l.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"index"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Possible values:"})," [",(0,l.jsx)(s.code,{children:"berserker"}),", ",(0,l.jsx)(s.code,{children:"champion"}),", ",(0,l.jsx)(s.code,{children:"devotion"}),", ",(0,l.jsx)(s.code,{children:"draconic"}),", ",(0,l.jsx)(s.code,{children:"evocation"}),", ",(0,l.jsx)(s.code,{children:"fiend"}),", ",(0,l.jsx)(s.code,{children:"hunter"}),", ",(0,l.jsx)(s.code,{children:"land"}),", ",(0,l.jsx)(s.code,{children:"life"}),", ",(0,l.jsx)(s.code,{children:"lore"}),", ",(0,l.jsx)(s.code,{children:"open-hand"}),", ",(0,l.jsx)(s.code,{children:"thief"}),"]"]})}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:["The ",(0,l.jsx)(s.code,{children:"index"})," of the subclass to get."]})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"subclass_level"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Possible values:"})," value \u2264 20"]})}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:["Example:\n",(0,l.jsx)("code",{children:"6"})]})})]})})]})]}),"\n",(0,l.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,l.jsx)("tbody",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsxs)("div",{style:{display:"flex"},children:[(0,l.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)("code",{children:"200"})}),(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"List of features for the subclass and level."})})]}),(0,l.jsx)("div",{children:(0,l.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("th",{style:{textAlign:"left"},children:[(0,l.jsx)("span",{children:"Schema "}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{})]})})}),(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"count"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"results"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"index"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"level"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"name"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"url"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},28453:(e,s,t)=>{t.d(s,{R:()=>r,x:()=>a});var l=t(96540);const i={},n=l.createContext(i);function r(e){const s=l.useContext(n);return l.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),l.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b2a6176d.df53c8fd.js b/assets/js/b2a6176d.df53c8fd.js new file mode 100644 index 0000000..880c69b --- /dev/null +++ b/assets/js/b2a6176d.df53c8fd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5884],{55:(e,s,t)=>{t.r(s),t.d(s,{contentTitle:()=>r,default:()=>d,frontMatter:()=>n,metadata:()=>a,toc:()=>c});var l=t(74848),i=t(28453);const n={},r="Get features of the requested spell level available to the class.",a={type:"api",id:"get-features-of-the-requested-spell-level-available-to-the-class",title:"Get features of the requested spell level available to the class.",description:"",slug:"/get-features-of-the-requested-spell-level-available-to-the-class",frontMatter:{},api:{tags:["Subclasses"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subclass to get.\n",schema:{type:"string",enum:["berserker","champion","devotion","draconic","evocation","fiend","hunter","land","life","lore","open-hand","thief"],example:"fiend"}},{name:"subclass_level",in:"path",required:!0,schema:{type:"integer",minimum:0,maximum:20},example:6}],responses:{200:{description:"List of features for the subclass and level.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get features of the requested spell level available to the class.",method:"get",path:"/api/subclasses/{index}/levels/{subclass_level}/features",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get features of the requested spell level available to the class.",description:{type:"text/plain"},url:{path:["api","subclasses",":index","levels",":subclass_level","features"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subclass to get.\n",type:"text/plain"},type:"any",value:"",key:"index"},{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"subclass_level"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-features-of-the-requested-spell-level-available-to-the-class",previous:{title:"Get level resources for a subclass and level.",permalink:"/docs/api/get-level-resources-for-a-subclass-and-level"},next:{title:"Get a subrace by index.",permalink:"/docs/api/get-a-subrace-by-index"}},c=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(s.header,{children:(0,l.jsx)(s.h1,{id:"get-features-of-the-requested-spell-level-available-to-the-class",children:"Get features of the requested spell level available to the class."})}),"\n",(0,l.jsx)(s.p,{children:"Get features of the requested spell level available to the class."}),"\n",(0,l.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"index"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Possible values:"})," [",(0,l.jsx)(s.code,{children:"berserker"}),", ",(0,l.jsx)(s.code,{children:"champion"}),", ",(0,l.jsx)(s.code,{children:"devotion"}),", ",(0,l.jsx)(s.code,{children:"draconic"}),", ",(0,l.jsx)(s.code,{children:"evocation"}),", ",(0,l.jsx)(s.code,{children:"fiend"}),", ",(0,l.jsx)(s.code,{children:"hunter"}),", ",(0,l.jsx)(s.code,{children:"land"}),", ",(0,l.jsx)(s.code,{children:"life"}),", ",(0,l.jsx)(s.code,{children:"lore"}),", ",(0,l.jsx)(s.code,{children:"open-hand"}),", ",(0,l.jsx)(s.code,{children:"thief"}),"]"]})}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:["The ",(0,l.jsx)(s.code,{children:"index"})," of the subclass to get."]})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"subclass_level"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Possible values:"})," value \u2264 20"]})}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:["Example:\n",(0,l.jsx)("code",{children:"6"})]})})]})})]})]}),"\n",(0,l.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,l.jsx)("tbody",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsxs)("div",{style:{display:"flex"},children:[(0,l.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)("code",{children:"200"})}),(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"List of features for the subclass and level."})})]}),(0,l.jsx)("div",{children:(0,l.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("th",{style:{textAlign:"left"},children:[(0,l.jsx)("span",{children:"Schema "}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{})]})})}),(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"count"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"results"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"index"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"name"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"url"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},28453:(e,s,t)=>{t.d(s,{R:()=>r,x:()=>a});var l=t(96540);const i={},n=l.createContext(i);function r(e){const s=l.useContext(n);return l.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),l.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bdef5384.75159869.js b/assets/js/bdef5384.75159869.js new file mode 100644 index 0000000..ce76088 --- /dev/null +++ b/assets/js/bdef5384.75159869.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2484],{27399:(e,s,i)=>{i.r(s),i.d(s,{contentTitle:()=>t,default:()=>d,frontMatter:()=>n,metadata:()=>a,toc:()=>c});var r=i(74848),l=i(28453);const n={},t="Get a subclass by index.",a={type:"api",id:"get-a-subclass-by-index",title:"Get a subclass by index.",description:"",slug:"/get-a-subclass-by-index",frontMatter:{},api:{description:"Subclasses reflect the different paths a class may take as levels are gained.",tags:["Subclasses"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subclass to get.\n",schema:{type:"string",enum:["berserker","champion","devotion","draconic","evocation","fiend","hunter","land","life","lore","open-hand","thief"],example:"fiend"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Subclass`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},class:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},subclass_flavor:{description:"Lore-friendly flavor text for a classes respective subclass.",type:"string"},subclass_levels:{description:"Resource url that shows the subclass level progression.",type:"string"},spells:{type:"array",items:{type:"object",properties:{prerequisites:{type:"array",items:{description:"`SpellPrerequisite`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},type:{description:"The type of prerequisite.",type:"string"}}}},spell:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}},example:{index:"fiend",name:"Fiend",url:"/api/subclasses/fiend",class:{index:"warlock",name:"Warlock",url:"/api/classes/warlock"},desc:["You have made a pact with a fiend from the lower planes of existence, a being whose aims are evil, even if you strive against those aims. Such beings desire the corruption or destruction of all things, ultimately including you. Fiends powerful enough to forge a pact include demon lords such as Demogorgon, Orcus, Fraz'Urb-luu, and Baphomet; archdevils such as Asmodeus, Dispater, Mephistopheles, and Belial; pit fiends and balors that are especially mighty; and ultroloths and other lords of the yugoloths."],spells:[{prerequisites:[{index:"warlock-1",name:"Warlock 1",type:"level",url:"/api/classes/warlock/levels/1"}],spell:{index:"burning-hands",name:"Burning Hands",url:"/api/spells/burning-hands"}},{prerequisites:[{index:"warlock-1",name:"Warlock 1",type:"level",url:"/api/classes/warlock/levels/1"}],spell:{index:"command",name:"Command",url:"/api/spells/command"}},{prerequisites:[{index:"warlock-3",name:"Warlock 3",type:"level",url:"/api/classes/warlock/levels/3"}],spell:{index:"blindness-deafness",name:"Blindness/Deafness",url:"/api/spells/blindness-deafness"}},{prerequisites:[{index:"warlock-3",name:"Warlock 3",type:"level",url:"/api/classes/warlock/levels/3"}],spell:{index:"scorching-ray",name:"Scorching Ray",url:"/api/spells/scorching-ray"}},{prerequisites:[{index:"warlock-5",name:"Warlock 5",type:"level",url:"/api/classes/warlock/levels/5"}],spell:{index:"fireball",name:"Fireball",url:"/api/spells/fireball"}},{prerequisites:[{index:"warlock-5",name:"Warlock 5",type:"level",url:"/api/classes/warlock/levels/5"}],spell:{index:"stinking-cloud",name:"Stinking Cloud",url:"/api/spells/stinking-cloud"}},{prerequisites:[{index:"warlock-7",name:"Warlock 7",type:"level",url:"/api/classes/warlock/levels/7"}],spell:{index:"fire-shield",name:"Fire Shield",url:"/api/spells/fire-shield"}},{prerequisites:[{index:"warlock-7",name:"Warlock 7",type:"level",url:"/api/classes/warlock/levels/7"}],spell:{index:"wall-of-fire",name:"Wall of Fire",url:"/api/spells/wall-of-fire"}},{prerequisites:[{index:"warlock-9",name:"Warlock 9",type:"level",url:"/api/classes/warlock/levels/9"}],spell:{index:"flame-strike",name:"Flame Strike",url:"/api/spells/flame-strike"}},{prerequisites:[{index:"warlock-9",name:"Warlock 9",type:"level",url:"/api/classes/warlock/levels/9"}],spell:{index:"hallow",name:"Hallow",url:"/api/spells/hallow"}}],subclass_flavor:"Otherworldly Patron",subclass_levels:"/api/subclasses/fiend/levels"}}}}},method:"get",path:"/api/subclasses/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a subclass by index.",description:{content:"Subclasses reflect the different paths a class may take as levels are gained.",type:"text/plain"},url:{path:["api","subclasses",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subclass to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-subclass-by-index",previous:{title:"Get a spell by index.",permalink:"/docs/api/get-a-spell-by-index"},next:{title:"Get features available for a subclass.",permalink:"/docs/api/get-features-available-for-a-subclass"}},c=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"get-a-subclass-by-index",children:"Get a subclass by index."})}),"\n",(0,r.jsx)(s.p,{children:"Subclasses reflect the different paths a class may take as levels are gained."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," [",(0,r.jsx)(s.code,{children:"berserker"}),", ",(0,r.jsx)(s.code,{children:"champion"}),", ",(0,r.jsx)(s.code,{children:"devotion"}),", ",(0,r.jsx)(s.code,{children:"draconic"}),", ",(0,r.jsx)(s.code,{children:"evocation"}),", ",(0,r.jsx)(s.code,{children:"fiend"}),", ",(0,r.jsx)(s.code,{children:"hunter"}),", ",(0,r.jsx)(s.code,{children:"land"}),", ",(0,r.jsx)(s.code,{children:"life"}),", ",(0,r.jsx)(s.code,{children:"lore"}),", ",(0,r.jsx)(s.code,{children:"open-hand"}),", ",(0,r.jsx)(s.code,{children:"thief"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"index"})," of the subclass to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Description of the resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"class"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"subclass_flavor"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Lore-friendly flavor text for a classes respective subclass."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"subclass_levels"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource url that shows the subclass level progression."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"spells"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"prerequisites"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"type"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"The type of prerequisite."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"spell"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,l.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,s,i)=>{i.d(s,{R:()=>t,x:()=>a});var r=i(96540);const l={},n=r.createContext(l);function t(e){const s=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:t(e.components),r.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bdef5384.79a6cdcd.js b/assets/js/bdef5384.79a6cdcd.js deleted file mode 100644 index 068acc9..0000000 --- a/assets/js/bdef5384.79a6cdcd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2484],{27399:(e,s,i)=>{i.r(s),i.d(s,{contentTitle:()=>t,default:()=>d,frontMatter:()=>n,metadata:()=>c,toc:()=>a});var r=i(74848),l=i(28453);const n={},t="Get a subclass by index.",c={type:"api",id:"get-a-subclass-by-index",title:"Get a subclass by index.",description:"",slug:"/get-a-subclass-by-index",frontMatter:{},api:{description:"Subclasses reflect the different paths a class may take as levels are gained.",tags:["Subclasses"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subclass to get.\n",schema:{type:"string",enum:["berserker","champion","devotion","draconic","evocation","fiend","hunter","land","life","lore","open-hand","thief"],example:"fiend"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Subclass`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},class:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},subclass_flavor:{description:"Lore-friendly flavor text for a classes respective subclass.",type:"string"},subclass_levels:{description:"Resource url that shows the subclass level progression.",type:"string"},spells:{type:"array",items:{type:"object",properties:{prerequisites:{type:"array",items:{description:"`SpellPrerequisite`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},type:{description:"The type of prerequisite.",type:"string"}}}},spell:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}},example:{index:"fiend",name:"Fiend",url:"/api/subclasses/fiend",class:{index:"warlock",name:"Warlock",url:"/api/classes/warlock"},desc:["You have made a pact with a fiend from the lower planes of existence, a being whose aims are evil, even if you strive against those aims. Such beings desire the corruption or destruction of all things, ultimately including you. Fiends powerful enough to forge a pact include demon lords such as Demogorgon, Orcus, Fraz'Urb-luu, and Baphomet; archdevils such as Asmodeus, Dispater, Mephistopheles, and Belial; pit fiends and balors that are especially mighty; and ultroloths and other lords of the yugoloths."],spells:[{prerequisites:[{index:"warlock-1",name:"Warlock 1",type:"level",url:"/api/classes/warlock/levels/1"}],spell:{index:"burning-hands",level:1,name:"Burning Hands",url:"/api/spells/burning-hands"}},{prerequisites:[{index:"warlock-1",name:"Warlock 1",type:"level",url:"/api/classes/warlock/levels/1"}],spell:{index:"command",level:1,name:"Command",url:"/api/spells/command"}},{prerequisites:[{index:"warlock-3",name:"Warlock 3",type:"level",url:"/api/classes/warlock/levels/3"}],spell:{index:"blindness-deafness",level:2,name:"Blindness/Deafness",url:"/api/spells/blindness-deafness"}},{prerequisites:[{index:"warlock-3",name:"Warlock 3",type:"level",url:"/api/classes/warlock/levels/3"}],spell:{index:"scorching-ray",level:2,name:"Scorching Ray",url:"/api/spells/scorching-ray"}},{prerequisites:[{index:"warlock-5",name:"Warlock 5",type:"level",url:"/api/classes/warlock/levels/5"}],spell:{index:"fireball",level:3,name:"Fireball",url:"/api/spells/fireball"}},{prerequisites:[{index:"warlock-5",name:"Warlock 5",type:"level",url:"/api/classes/warlock/levels/5"}],spell:{index:"stinking-cloud",level:3,name:"Stinking Cloud",url:"/api/spells/stinking-cloud"}},{prerequisites:[{index:"warlock-7",name:"Warlock 7",type:"level",url:"/api/classes/warlock/levels/7"}],spell:{index:"fire-shield",level:4,name:"Fire Shield",url:"/api/spells/fire-shield"}},{prerequisites:[{index:"warlock-7",name:"Warlock 7",type:"level",url:"/api/classes/warlock/levels/7"}],spell:{index:"wall-of-fire",level:4,name:"Wall of Fire",url:"/api/spells/wall-of-fire"}},{prerequisites:[{index:"warlock-9",name:"Warlock 9",type:"level",url:"/api/classes/warlock/levels/9"}],spell:{index:"flame-strike",level:5,name:"Flame Strike",url:"/api/spells/flame-strike"}},{prerequisites:[{index:"warlock-9",name:"Warlock 9",type:"level",url:"/api/classes/warlock/levels/9"}],spell:{index:"hallow",level:5,name:"Hallow",url:"/api/spells/hallow"}}],subclass_flavor:"Otherworldly Patron",subclass_levels:"/api/subclasses/fiend/levels"}}}}},method:"get",path:"/api/subclasses/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a subclass by index.",description:{content:"Subclasses reflect the different paths a class may take as levels are gained.",type:"text/plain"},url:{path:["api","subclasses",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subclass to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-subclass-by-index",previous:{title:"Get a spell by index.",permalink:"/docs/api/get-a-spell-by-index"},next:{title:"Get features available for a subclass.",permalink:"/docs/api/get-features-available-for-a-subclass"}},a=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"get-a-subclass-by-index",children:"Get a subclass by index."})}),"\n",(0,r.jsx)(s.p,{children:"Subclasses reflect the different paths a class may take as levels are gained."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," [",(0,r.jsx)(s.code,{children:"berserker"}),", ",(0,r.jsx)(s.code,{children:"champion"}),", ",(0,r.jsx)(s.code,{children:"devotion"}),", ",(0,r.jsx)(s.code,{children:"draconic"}),", ",(0,r.jsx)(s.code,{children:"evocation"}),", ",(0,r.jsx)(s.code,{children:"fiend"}),", ",(0,r.jsx)(s.code,{children:"hunter"}),", ",(0,r.jsx)(s.code,{children:"land"}),", ",(0,r.jsx)(s.code,{children:"life"}),", ",(0,r.jsx)(s.code,{children:"lore"}),", ",(0,r.jsx)(s.code,{children:"open-hand"}),", ",(0,r.jsx)(s.code,{children:"thief"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"index"})," of the subclass to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Description of the resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"class"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"subclass_flavor"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Lore-friendly flavor text for a classes respective subclass."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"subclass_levels"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource url that shows the subclass level progression."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"spells"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"prerequisites"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"type"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"The type of prerequisite."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"spell"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,l.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,s,i)=>{i.d(s,{R:()=>t,x:()=>c});var r=i(96540);const l={},n=r.createContext(l);function t(e){const s=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:t(e.components),r.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c2c0fda6.1c5c6d23.js b/assets/js/c2c0fda6.1c5c6d23.js deleted file mode 100644 index eeb0370..0000000 --- a/assets/js/c2c0fda6.1c5c6d23.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8926],{29053:(e,s,i)=>{i.r(s),i.d(s,{contentTitle:()=>l,default:()=>d,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var r=i(74848),n=i(28453);const t={},l="Get subclasses available for a class.",a={type:"api",id:"get-subclasses-available-for-a-class",title:"Get subclasses available for a class.",description:"",slug:"/get-subclasses-available-for-a-class",frontMatter:{},api:{tags:["Class Resource Lists"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{count:1,results:[{index:"berserker",name:"Berserker",url:"/api/subclasses/berserker"}]}}}}},description:"Get subclasses available for a class.",method:"get",path:"/api/classes/{index}/subclasses",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get subclasses available for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","subclasses"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-subclasses-available-for-a-class",previous:{title:"Get a class by index.",permalink:"/docs/api/get-a-class-by-index"},next:{title:"Get spells available for a class.",permalink:"/docs/api/get-spells-available-for-a-class"}},c=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"get-subclasses-available-for-a-class",children:"Get subclasses available for a class."})}),"\n",(0,r.jsx)(s.p,{children:"Get subclasses available for a class."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," [",(0,r.jsx)(s.code,{children:"barbarian"}),", ",(0,r.jsx)(s.code,{children:"bard"}),", ",(0,r.jsx)(s.code,{children:"cleric"}),", ",(0,r.jsx)(s.code,{children:"druid"}),", ",(0,r.jsx)(s.code,{children:"fighter"}),", ",(0,r.jsx)(s.code,{children:"monk"}),", ",(0,r.jsx)(s.code,{children:"paladin"}),", ",(0,r.jsx)(s.code,{children:"ranger"}),", ",(0,r.jsx)(s.code,{children:"rogue"}),", ",(0,r.jsx)(s.code,{children:"sorcerer"}),", ",(0,r.jsx)(s.code,{children:"warlock"}),", ",(0,r.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,s,i)=>{i.d(s,{R:()=>l,x:()=>a});var r=i(96540);const n={},t=r.createContext(n);function l(e){const s=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c2c0fda6.e6ce0207.js b/assets/js/c2c0fda6.e6ce0207.js new file mode 100644 index 0000000..1b92184 --- /dev/null +++ b/assets/js/c2c0fda6.e6ce0207.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8926],{29053:(e,s,i)=>{i.r(s),i.d(s,{contentTitle:()=>l,default:()=>d,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var r=i(74848),n=i(28453);const t={},l="Get subclasses available for a class.",a={type:"api",id:"get-subclasses-available-for-a-class",title:"Get subclasses available for a class.",description:"",slug:"/get-subclasses-available-for-a-class",frontMatter:{},api:{tags:["Class Resource Lists"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{count:1,results:[{index:"berserker",name:"Berserker",url:"/api/subclasses/berserker"}]}}}}},description:"Get subclasses available for a class.",method:"get",path:"/api/classes/{index}/subclasses",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get subclasses available for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","subclasses"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-subclasses-available-for-a-class",previous:{title:"Get a class by index.",permalink:"/docs/api/get-a-class-by-index"},next:{title:"Get spells available for a class.",permalink:"/docs/api/get-spells-available-for-a-class"}},c=[];function o(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"get-subclasses-available-for-a-class",children:"Get subclasses available for a class."})}),"\n",(0,r.jsx)(s.p,{children:"Get subclasses available for a class."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," [",(0,r.jsx)(s.code,{children:"barbarian"}),", ",(0,r.jsx)(s.code,{children:"bard"}),", ",(0,r.jsx)(s.code,{children:"cleric"}),", ",(0,r.jsx)(s.code,{children:"druid"}),", ",(0,r.jsx)(s.code,{children:"fighter"}),", ",(0,r.jsx)(s.code,{children:"monk"}),", ",(0,r.jsx)(s.code,{children:"paladin"}),", ",(0,r.jsx)(s.code,{children:"ranger"}),", ",(0,r.jsx)(s.code,{children:"rogue"}),", ",(0,r.jsx)(s.code,{children:"sorcerer"}),", ",(0,r.jsx)(s.code,{children:"warlock"}),", ",(0,r.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,s,i)=>{i.d(s,{R:()=>l,x:()=>a});var r=i(96540);const n={},t=r.createContext(n);function l(e){const s=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c57c8e3d.91f549b8.js b/assets/js/c57c8e3d.91f549b8.js deleted file mode 100644 index 0a35d21..0000000 --- a/assets/js/c57c8e3d.91f549b8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[613],{92674:(e,s,l)=>{l.r(s),l.d(s,{contentTitle:()=>t,default:()=>a,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var n=l(74848),i=l(28453);const r={},t="Get level resources for a subclass and level.",o={type:"api",id:"get-level-resources-for-a-subclass-and-level",title:"Get level resources for a subclass and level.",description:"",slug:"/get-level-resources-for-a-subclass-and-level",frontMatter:{},api:{tags:["Subclasses"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subclass to get.\n",schema:{type:"string",enum:["berserker","champion","devotion","draconic","evocation","fiend","hunter","land","life","lore","open-hand","thief"],example:"fiend"}},{name:"subclass_level",in:"path",required:!0,schema:{type:"integer",minimum:1,maximum:20},example:6}],responses:{200:{description:"Level resource for the subclass and level.",content:{"application/json":{schema:{description:"`SubclassLevel`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},level:{description:"Number value for the current level object.",type:"number"},ability_score_bonuses:{description:"Total number of ability score bonuses gained, added from previous levels.",type:"number"},prof_bonus:{description:"Proficiency bonus for this class at the specified level.",type:"number"},features:{description:"List of features gained at this level.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},spellcasting:{description:"Summary of spells known at this level.",type:"object",properties:{cantrips_known:{type:"number"},spells_known:{type:"number"},spell_slots_level_1:{type:"number"},spell_slots_level_2:{type:"number"},spell_slots_level_3:{type:"number"},spell_slots_level_4:{type:"number"},spell_slots_level_5:{type:"number"},spell_slots_level_6:{type:"number"},spell_slots_level_7:{type:"number"},spell_slots_level_8:{type:"number"},spell_slots_level_9:{type:"number"}}},classspecific:{description:"Class specific information such as dice values for bard songs and number of warlock invocations.",additionalProperties:{}}}},example:{index:"devotion-3",url:"/api/subclasses/devotion/levels/3",class:{index:"paladin",name:"Paladin",url:"/api/classes/paladin"},features:[{index:"channel-divinity",name:"Channel Divinity",url:"/api/features/channel-divinity"}],level:3,subclass:{index:"devotion",name:"Devotion",url:"/api/subclasses/devotion"}}}}}},description:"Get level resources for a subclass and level.",method:"get",path:"/api/subclasses/{index}/levels/{subclass_level}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get level resources for a subclass and level.",description:{type:"text/plain"},url:{path:["api","subclasses",":index","levels",":subclass_level"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subclass to get.\n",type:"text/plain"},type:"any",value:"",key:"index"},{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"subclass_level"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-level-resources-for-a-subclass-and-level",previous:{title:"Get all level resources for a subclass.",permalink:"/docs/api/get-all-level-resources-for-a-subclass"},next:{title:"Get features of the requested spell level available to the class.",permalink:"/docs/api/get-features-of-the-requested-spell-level-available-to-the-class"}},c=[];function d(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"get-level-resources-for-a-subclass-and-level",children:"Get level resources for a subclass and level."})}),"\n",(0,n.jsx)(s.p,{children:"Get level resources for a subclass and level."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"Possible values:"})," [",(0,n.jsx)(s.code,{children:"berserker"}),", ",(0,n.jsx)(s.code,{children:"champion"}),", ",(0,n.jsx)(s.code,{children:"devotion"}),", ",(0,n.jsx)(s.code,{children:"draconic"}),", ",(0,n.jsx)(s.code,{children:"evocation"}),", ",(0,n.jsx)(s.code,{children:"fiend"}),", ",(0,n.jsx)(s.code,{children:"hunter"}),", ",(0,n.jsx)(s.code,{children:"land"}),", ",(0,n.jsx)(s.code,{children:"life"}),", ",(0,n.jsx)(s.code,{children:"lore"}),", ",(0,n.jsx)(s.code,{children:"open-hand"}),", ",(0,n.jsx)(s.code,{children:"thief"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(s.p,{children:["The ",(0,n.jsx)(s.code,{children:"index"})," of the subclass to get."]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"subclass_level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"Possible values:"})," 1 \u2264 value \u2264 20"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(s.p,{children:["Example:\n",(0,n.jsx)("code",{children:"6"})]})})]})})]})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Level resource for the subclass and level."})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Number value for the current level object."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_score_bonuses"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Total number of ability score bonuses gained, added from previous levels."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"prof_bonus"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Proficiency bonus for this class at the specified level."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"features"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"List of features gained at this level."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spellcasting"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Summary of spells known at this level."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"cantrips_known"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spells_known"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_1"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_2"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_3"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_4"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_5"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_6"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_7"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_8"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_9"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"classspecific"}),(0,n.jsx)("span",{style:{opacity:"0.6"}}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Class specific information such as dice values for bard songs and number of warlock invocations."})})]})})]})]})})]})})})]})]})}function a(e){void 0===e&&(e={});const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453:(e,s,l)=>{l.d(s,{R:()=>t,x:()=>o});var n=l(96540);const i={},r=n.createContext(i);function t(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c57c8e3d.f4bfbd88.js b/assets/js/c57c8e3d.f4bfbd88.js new file mode 100644 index 0000000..d241eaf --- /dev/null +++ b/assets/js/c57c8e3d.f4bfbd88.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[613],{92674:(e,s,l)=>{l.r(s),l.d(s,{contentTitle:()=>t,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var n=l(74848),i=l(28453);const r={},t="Get level resources for a subclass and level.",o={type:"api",id:"get-level-resources-for-a-subclass-and-level",title:"Get level resources for a subclass and level.",description:"",slug:"/get-level-resources-for-a-subclass-and-level",frontMatter:{},api:{tags:["Subclasses"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subclass to get.\n",schema:{type:"string",enum:["berserker","champion","devotion","draconic","evocation","fiend","hunter","land","life","lore","open-hand","thief"],example:"fiend"}},{name:"subclass_level",in:"path",required:!0,schema:{type:"integer",minimum:1,maximum:20},example:6}],responses:{200:{description:"Level resource for the subclass and level.",content:{"application/json":{schema:{description:"`SubclassLevel`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},level:{description:"Number value for the current level object.",type:"number"},ability_score_bonuses:{description:"Total number of ability score bonuses gained, added from previous levels.",type:"number"},prof_bonus:{description:"Proficiency bonus for this class at the specified level.",type:"number"},features:{description:"List of features gained at this level.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},spellcasting:{description:"Summary of spells known at this level.",type:"object",properties:{cantrips_known:{type:"number"},spells_known:{type:"number"},spell_slots_level_1:{type:"number"},spell_slots_level_2:{type:"number"},spell_slots_level_3:{type:"number"},spell_slots_level_4:{type:"number"},spell_slots_level_5:{type:"number"},spell_slots_level_6:{type:"number"},spell_slots_level_7:{type:"number"},spell_slots_level_8:{type:"number"},spell_slots_level_9:{type:"number"}}},classspecific:{description:"Class specific information such as dice values for bard songs and number of warlock invocations.",additionalProperties:{}}}},example:{index:"devotion-3",url:"/api/subclasses/devotion/levels/3",class:{index:"paladin",name:"Paladin",url:"/api/classes/paladin"},features:[{index:"channel-divinity",name:"Channel Divinity",url:"/api/features/channel-divinity"}],level:3,subclass:{index:"devotion",name:"Devotion",url:"/api/subclasses/devotion"}}}}}},description:"Get level resources for a subclass and level.",method:"get",path:"/api/subclasses/{index}/levels/{subclass_level}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get level resources for a subclass and level.",description:{type:"text/plain"},url:{path:["api","subclasses",":index","levels",":subclass_level"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subclass to get.\n",type:"text/plain"},type:"any",value:"",key:"index"},{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"subclass_level"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-level-resources-for-a-subclass-and-level",previous:{title:"Get all level resources for a subclass.",permalink:"/docs/api/get-all-level-resources-for-a-subclass"},next:{title:"Get features of the requested spell level available to the class.",permalink:"/docs/api/get-features-of-the-requested-spell-level-available-to-the-class"}},c=[];function a(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"get-level-resources-for-a-subclass-and-level",children:"Get level resources for a subclass and level."})}),"\n",(0,n.jsx)(s.p,{children:"Get level resources for a subclass and level."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"Possible values:"})," [",(0,n.jsx)(s.code,{children:"berserker"}),", ",(0,n.jsx)(s.code,{children:"champion"}),", ",(0,n.jsx)(s.code,{children:"devotion"}),", ",(0,n.jsx)(s.code,{children:"draconic"}),", ",(0,n.jsx)(s.code,{children:"evocation"}),", ",(0,n.jsx)(s.code,{children:"fiend"}),", ",(0,n.jsx)(s.code,{children:"hunter"}),", ",(0,n.jsx)(s.code,{children:"land"}),", ",(0,n.jsx)(s.code,{children:"life"}),", ",(0,n.jsx)(s.code,{children:"lore"}),", ",(0,n.jsx)(s.code,{children:"open-hand"}),", ",(0,n.jsx)(s.code,{children:"thief"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(s.p,{children:["The ",(0,n.jsx)(s.code,{children:"index"})," of the subclass to get."]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"subclass_level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"Possible values:"})," 1 \u2264 value \u2264 20"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(s.p,{children:["Example:\n",(0,n.jsx)("code",{children:"6"})]})})]})})]})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Level resource for the subclass and level."})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Number value for the current level object."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_score_bonuses"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Total number of ability score bonuses gained, added from previous levels."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"prof_bonus"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Proficiency bonus for this class at the specified level."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"features"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"List of features gained at this level."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spellcasting"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Summary of spells known at this level."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"cantrips_known"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spells_known"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_1"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_2"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_3"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_4"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_5"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_6"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_7"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_8"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spell_slots_level_9"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"classspecific"}),(0,n.jsx)("span",{style:{opacity:"0.6"}}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(s.p,{children:"Class specific information such as dice values for bard songs and number of warlock invocations."})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,s,l)=>{l.d(s,{R:()=>t,x:()=>o});var n=l(96540);const i={},r=n.createContext(i);function t(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c5b3f5ce.22e92835.js b/assets/js/c5b3f5ce.22e92835.js new file mode 100644 index 0000000..6f8bd8c --- /dev/null +++ b/assets/js/c5b3f5ce.22e92835.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2597],{23927:(e,n,t)=>{t.r(n),t.d(n,{contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(74848),r=t(28453);const o={},s="Get a weapon property by index.",a={type:"api",id:"get-a-weapon-property-by-index",title:"Get a weapon property by index.",description:"",slug:"/get-a-weapon-property-by-index",frontMatter:{},api:{tags:["Equipment"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the weapon property to get.\n",schema:{type:"string",enum:["ammunition","finesse","heavy","light","loading","monk","reach","special","thrown","two-handed","versatile"],example:"ammunition"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"WeaponProperty",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}}}},example:{index:"ammunition",name:"Ammunition",url:"/api/weapon-properties/ammunition",desc:["You can use a weapon that has the ammunition property to make a ranged attack only if you have ammunition to fire from the weapon. Each time you attack with the weapon, you expend one piece of ammunition. Drawing the ammunition from a quiver, case, or other container is part of the attack (you need a free hand to load a one-handed weapon).",'At the end of the battle, you can recover half your expended ammunition by taking a minute to search the battlefield. If you use a weapon that has the ammunition property to make a melee attack, you treat the weapon as an improvised weapon (see "Improvised Weapons" later in the section). A sling must be loaded to deal any damage when used in this way.']}}}}},description:"Get a weapon property by index.",method:"get",path:"/api/weapon-properties/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a weapon property by index.",description:{type:"text/plain"},url:{path:["api","weapon-properties",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the weapon property to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-weapon-property-by-index",previous:{title:"Get a trait by index.",permalink:"/docs/api/get-a-trait-by-index"}},d=[];function c(e){const n={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"get-a-weapon-property-by-index",children:"Get a weapon property by index."})}),"\n",(0,i.jsx)(n.p,{children:"Get a weapon property by index."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Possible values:"})," [",(0,i.jsx)(n.code,{children:"ammunition"}),", ",(0,i.jsx)(n.code,{children:"finesse"}),", ",(0,i.jsx)(n.code,{children:"heavy"}),", ",(0,i.jsx)(n.code,{children:"light"}),", ",(0,i.jsx)(n.code,{children:"loading"}),", ",(0,i.jsx)(n.code,{children:"monk"}),", ",(0,i.jsx)(n.code,{children:"reach"}),", ",(0,i.jsx)(n.code,{children:"special"}),", ",(0,i.jsx)(n.code,{children:"thrown"}),", ",(0,i.jsx)(n.code,{children:"two-handed"}),", ",(0,i.jsx)(n.code,{children:"versatile"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"index"})," of the weapon property to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"desc"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Description of the resource."})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>a});var i=t(96540);const r={},o=i.createContext(r);function s(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c5b3f5ce.c8a0ad3f.js b/assets/js/c5b3f5ce.c8a0ad3f.js deleted file mode 100644 index 892b993..0000000 --- a/assets/js/c5b3f5ce.c8a0ad3f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2597],{23927:(e,n,t)=>{t.r(n),t.d(n,{contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(74848),r=t(28453);const o={},s="Get a weapon property by index.",a={type:"api",id:"get-a-weapon-property-by-index",title:"Get a weapon property by index.",description:"",slug:"/get-a-weapon-property-by-index",frontMatter:{},api:{tags:["Equipment"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the weapon property to get.\n",schema:{type:"string",enum:["ammunition","finesse","heavy","light","loading","monk","reach","special","thrown","two-handed","versatile"],example:"ammunition"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"WeaponProperty",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}}}},example:{index:"ammunition",name:"Ammunition",url:"/api/weapon-properties/ammunition",desc:["You can use a weapon that has the ammunition property to make a ranged attack only if you have ammunition to fire from the weapon. Each time you attack with the weapon, you expend one piece of ammunition. Drawing the ammunition from a quiver, case, or other container is part of the attack (you need a free hand to load a one-handed weapon).",'At the end of the battle, you can recover half your expended ammunition by taking a minute to search the battlefield. If you use a weapon that has the ammunition property to make a melee attack, you treat the weapon as an improvised weapon (see "Improvised Weapons" later in the section). A sling must be loaded to deal any damage when used in this way.']}}}}},description:"Get a weapon property by index.",method:"get",path:"/api/weapon-properties/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a weapon property by index.",description:{type:"text/plain"},url:{path:["api","weapon-properties",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the weapon property to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-weapon-property-by-index",previous:{title:"Get a trait by index.",permalink:"/docs/api/get-a-trait-by-index"}},d=[];function c(e){const n={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"get-a-weapon-property-by-index",children:"Get a weapon property by index."})}),"\n",(0,i.jsx)(n.p,{children:"Get a weapon property by index."}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Possible values:"})," [",(0,i.jsx)(n.code,{children:"ammunition"}),", ",(0,i.jsx)(n.code,{children:"finesse"}),", ",(0,i.jsx)(n.code,{children:"heavy"}),", ",(0,i.jsx)(n.code,{children:"light"}),", ",(0,i.jsx)(n.code,{children:"loading"}),", ",(0,i.jsx)(n.code,{children:"monk"}),", ",(0,i.jsx)(n.code,{children:"reach"}),", ",(0,i.jsx)(n.code,{children:"special"}),", ",(0,i.jsx)(n.code,{children:"thrown"}),", ",(0,i.jsx)(n.code,{children:"two-handed"}),", ",(0,i.jsx)(n.code,{children:"versatile"}),"]"]})}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"index"})," of the weapon property to get."]})})]})})})]}),"\n",(0,i.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,i.jsx)("tbody",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsxs)("div",{style:{display:"flex"},children:[(0,i.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)("code",{children:"200"})}),(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"OK"})})]}),(0,i.jsx)("div",{children:(0,i.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,i.jsx)("thead",{children:(0,i.jsx)("tr",{children:(0,i.jsxs)("th",{style:{textAlign:"left"},children:[(0,i.jsx)("span",{children:"Schema "}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{})]})})}),(0,i.jsxs)("tbody",{children:[(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"index"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Resource index for shorthand searching."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"level"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Level of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"name"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Name of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"url"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"URL of the referenced resource."})})]})}),(0,i.jsx)("tr",{children:(0,i.jsxs)("td",{children:[(0,i.jsx)("code",{children:"desc"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,i.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,i.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,i.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,i.jsx)(n.p,{children:"Description of the resource."})})]})})]})]})})]})})})]})]})}function l(e){void 0===e&&(e={});const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>a});var i=t(96540);const r={},o=i.createContext(r);function s(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c60b12b2.0e50cb08.js b/assets/js/c60b12b2.0e50cb08.js new file mode 100644 index 0000000..ff9455d --- /dev/null +++ b/assets/js/c60b12b2.0e50cb08.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6979],{8202:(e,s,t)=>{t.r(s),t.d(s,{contentTitle:()=>n,default:()=>o,frontMatter:()=>l,metadata:()=>a,toc:()=>c});var r=t(74848),i=t(28453);const l={},n="Get features available to a class at the requested level.",a={type:"api",id:"get-features-available-to-a-class-at-the-requested-level",title:"Get features available to a class at the requested level.",description:"",slug:"/get-features-available-to-a-class-at-the-requested-level",frontMatter:{},api:{tags:["Class Levels"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}},{name:"class_level",in:"path",required:!0,schema:{type:"number",minimum:0,maximum:20,example:3}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{count:2,results:[{index:"barbarian-unarmored-defense",name:"Unarmored Defense",url:"/api/features/barbarian-unarmored-defense"},{index:"rage",name:"Rage",url:"/api/features/rage"}]}}}}},description:"Get features available to a class at the requested level.",method:"get",path:"/api/classes/{index}/levels/{class_level}/features",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get features available to a class at the requested level.",description:{type:"text/plain"},url:{path:["api","classes",":index","levels",":class_level","features"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"},{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"class_level"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-features-available-to-a-class-at-the-requested-level",previous:{title:"Get level resource for a class and level.",permalink:"/docs/api/get-level-resource-for-a-class-and-level"},next:{title:"Get spells of the requested level available to the class.",permalink:"/docs/api/get-spells-of-the-requested-level-available-to-the-class"}},c=[];function d(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"get-features-available-to-a-class-at-the-requested-level",children:"Get features available to a class at the requested level."})}),"\n",(0,r.jsx)(s.p,{children:"Get features available to a class at the requested level."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," [",(0,r.jsx)(s.code,{children:"barbarian"}),", ",(0,r.jsx)(s.code,{children:"bard"}),", ",(0,r.jsx)(s.code,{children:"cleric"}),", ",(0,r.jsx)(s.code,{children:"druid"}),", ",(0,r.jsx)(s.code,{children:"fighter"}),", ",(0,r.jsx)(s.code,{children:"monk"}),", ",(0,r.jsx)(s.code,{children:"paladin"}),", ",(0,r.jsx)(s.code,{children:"ranger"}),", ",(0,r.jsx)(s.code,{children:"rogue"}),", ",(0,r.jsx)(s.code,{children:"sorcerer"}),", ",(0,r.jsx)(s.code,{children:"warlock"}),", ",(0,r.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"index"})," of the class to get."]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"class_level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," value \u2264 20"]})})]})})]})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function o(e){void 0===e&&(e={});const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},28453:(e,s,t)=>{t.d(s,{R:()=>n,x:()=>a});var r=t(96540);const i={},l=r.createContext(i);function n(e){const s=r.useContext(l);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:n(e.components),r.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c60b12b2.9f2883b5.js b/assets/js/c60b12b2.9f2883b5.js deleted file mode 100644 index 7d31830..0000000 --- a/assets/js/c60b12b2.9f2883b5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6979],{8202:(e,s,t)=>{t.r(s),t.d(s,{contentTitle:()=>n,default:()=>o,frontMatter:()=>l,metadata:()=>a,toc:()=>c});var r=t(74848),i=t(28453);const l={},n="Get features available to a class at the requested level.",a={type:"api",id:"get-features-available-to-a-class-at-the-requested-level",title:"Get features available to a class at the requested level.",description:"",slug:"/get-features-available-to-a-class-at-the-requested-level",frontMatter:{},api:{tags:["Class Levels"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}},{name:"class_level",in:"path",required:!0,schema:{type:"number",minimum:0,maximum:20,example:3}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{count:2,results:[{index:"barbarian-unarmored-defense",name:"Unarmored Defense",url:"/api/features/barbarian-unarmored-defense"},{index:"rage",name:"Rage",url:"/api/features/rage"}]}}}}},description:"Get features available to a class at the requested level.",method:"get",path:"/api/classes/{index}/levels/{class_level}/features",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get features available to a class at the requested level.",description:{type:"text/plain"},url:{path:["api","classes",":index","levels",":class_level","features"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"},{description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"class_level"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-features-available-to-a-class-at-the-requested-level",previous:{title:"Get level resource for a class and level.",permalink:"/docs/api/get-level-resource-for-a-class-and-level"},next:{title:"Get spells of the requested level available to the class.",permalink:"/docs/api/get-spells-of-the-requested-level-available-to-the-class"}},c=[];function d(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"get-features-available-to-a-class-at-the-requested-level",children:"Get features available to a class at the requested level."})}),"\n",(0,r.jsx)(s.p,{children:"Get features available to a class at the requested level."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," [",(0,r.jsx)(s.code,{children:"barbarian"}),", ",(0,r.jsx)(s.code,{children:"bard"}),", ",(0,r.jsx)(s.code,{children:"cleric"}),", ",(0,r.jsx)(s.code,{children:"druid"}),", ",(0,r.jsx)(s.code,{children:"fighter"}),", ",(0,r.jsx)(s.code,{children:"monk"}),", ",(0,r.jsx)(s.code,{children:"paladin"}),", ",(0,r.jsx)(s.code,{children:"ranger"}),", ",(0,r.jsx)(s.code,{children:"rogue"}),", ",(0,r.jsx)(s.code,{children:"sorcerer"}),", ",(0,r.jsx)(s.code,{children:"warlock"}),", ",(0,r.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"index"})," of the class to get."]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"class_level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," value \u2264 20"]})})]})})]})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function o(e){void 0===e&&(e={});const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},28453:(e,s,t)=>{t.d(s,{R:()=>n,x:()=>a});var r=t(96540);const i={},l=r.createContext(i);function n(e){const s=r.useContext(l);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:n(e.components),r.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cc2a131f.17249466.js b/assets/js/cc2a131f.17249466.js new file mode 100644 index 0000000..15ac73f --- /dev/null +++ b/assets/js/cc2a131f.17249466.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6231],{11106:(e,i,s)=>{s.r(i),s.d(i,{contentTitle:()=>c,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var r=s(74848),t=s(28453);const n={},c="Get multiclassing resource for a class.",o={type:"api",id:"get-multiclassing-resource-for-a-class",title:"Get multiclassing resource for a class.",description:"",slug:"/get-multiclassing-resource-for-a-class",frontMatter:{},api:{tags:["Class"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Multiclassing`\n",type:"object",properties:{prerequisites:{description:"List of prerequisites that must be met.",type:"array",items:{description:"`Prerequisite`\n",type:"object",properties:{ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},minimum_score:{description:"Minimum score to meet the prerequisite.",type:"number"}}}},prerequisite_options:{description:"List of choices of prerequisites to meet for.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}},proficiencies:{description:"List of proficiencies available when multiclassing.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},proficiency_choices:{description:"List of choices of proficiencies that are given when multiclassing.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}}}},example:{prerequisites:[{ability_score:{index:"str",name:"STR",url:"/api/ability-scores/str"},minimum_score:13}],proficiencies:[{index:"shields",name:"Shields",url:"/api/proficiencies/shields"},{index:"simple-weapons",name:"Simple Weapons",url:"/api/proficiencies/simple-weapons"},{index:"martial-weapons",name:"Martial Weapons",url:"/api/proficiencies/martial-weapons"}],proficiency_choices:[]}}}}},description:"Get multiclassing resource for a class.",method:"get",path:"/api/classes/{index}/multi-classing",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get multiclassing resource for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","multi-classing"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-multiclassing-resource-for-a-class",previous:{title:"Get proficiencies available for a class.",permalink:"/docs/api/get-proficiencies-available-for-a-class"},next:{title:"Get all level resources for a class.",permalink:"/docs/api/get-all-level-resources-for-a-class"}},l=[];function a(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"get-multiclassing-resource-for-a-class",children:"Get multiclassing resource for a class."})}),"\n",(0,r.jsx)(i.p,{children:"Get multiclassing resource for a class."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"Possible values:"})," [",(0,r.jsx)(i.code,{children:"barbarian"}),", ",(0,r.jsx)(i.code,{children:"bard"}),", ",(0,r.jsx)(i.code,{children:"cleric"}),", ",(0,r.jsx)(i.code,{children:"druid"}),", ",(0,r.jsx)(i.code,{children:"fighter"}),", ",(0,r.jsx)(i.code,{children:"monk"}),", ",(0,r.jsx)(i.code,{children:"paladin"}),", ",(0,r.jsx)(i.code,{children:"ranger"}),", ",(0,r.jsx)(i.code,{children:"rogue"}),", ",(0,r.jsx)(i.code,{children:"sorcerer"}),", ",(0,r.jsx)(i.code,{children:"warlock"}),", ",(0,r.jsx)(i.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:["The ",(0,r.jsx)(i.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(i.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"prerequisites"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of prerequisites that must be met."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"ability_score"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:(0,r.jsx)(i.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"minimum_score"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Minimum score to meet the prerequisite."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"prerequisite_options"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of choices of prerequisites to meet for."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"choose"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"type"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"from"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"proficiencies"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of proficiencies available when multiclassing."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"proficiency_choices"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of choices of proficiencies that are given when multiclassing."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"choose"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"type"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"from"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},28453:(e,i,s)=>{s.d(i,{R:()=>c,x:()=>o});var r=s(96540);const t={},n=r.createContext(t);function c(e){const i=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(n.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cc2a131f.a9ede930.js b/assets/js/cc2a131f.a9ede930.js deleted file mode 100644 index d2ed854..0000000 --- a/assets/js/cc2a131f.a9ede930.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6231],{11106:(e,i,s)=>{s.r(i),s.d(i,{contentTitle:()=>c,default:()=>a,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var r=s(74848),t=s(28453);const n={},c="Get multiclassing resource for a class.",o={type:"api",id:"get-multiclassing-resource-for-a-class",title:"Get multiclassing resource for a class.",description:"",slug:"/get-multiclassing-resource-for-a-class",frontMatter:{},api:{tags:["Class"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Multiclassing`\n",type:"object",properties:{prerequisites:{description:"List of prerequisites that must be met.",type:"array",items:{description:"`Prerequisite`\n",type:"object",properties:{ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},minimum_score:{description:"Minimum score to meet the prerequisite.",type:"number"}}}},prerequisite_options:{description:"List of choices of prerequisites to meet for.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}},proficiencies:{description:"List of proficiencies available when multiclassing.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},proficiency_choices:{description:"List of choices of proficiencies that are given when multiclassing.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}}}},example:{prerequisites:[{ability_score:{index:"str",name:"STR",url:"/api/ability-scores/str"},minimum_score:13}],proficiencies:[{index:"shields",name:"Shields",url:"/api/proficiencies/shields"},{index:"simple-weapons",name:"Simple Weapons",url:"/api/proficiencies/simple-weapons"},{index:"martial-weapons",name:"Martial Weapons",url:"/api/proficiencies/martial-weapons"}],proficiency_choices:[]}}}}},description:"Get multiclassing resource for a class.",method:"get",path:"/api/classes/{index}/multi-classing",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get multiclassing resource for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","multi-classing"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-multiclassing-resource-for-a-class",previous:{title:"Get proficiencies available for a class.",permalink:"/docs/api/get-proficiencies-available-for-a-class"},next:{title:"Get all level resources for a class.",permalink:"/docs/api/get-all-level-resources-for-a-class"}},l=[];function d(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"get-multiclassing-resource-for-a-class",children:"Get multiclassing resource for a class."})}),"\n",(0,r.jsx)(i.p,{children:"Get multiclassing resource for a class."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"Possible values:"})," [",(0,r.jsx)(i.code,{children:"barbarian"}),", ",(0,r.jsx)(i.code,{children:"bard"}),", ",(0,r.jsx)(i.code,{children:"cleric"}),", ",(0,r.jsx)(i.code,{children:"druid"}),", ",(0,r.jsx)(i.code,{children:"fighter"}),", ",(0,r.jsx)(i.code,{children:"monk"}),", ",(0,r.jsx)(i.code,{children:"paladin"}),", ",(0,r.jsx)(i.code,{children:"ranger"}),", ",(0,r.jsx)(i.code,{children:"rogue"}),", ",(0,r.jsx)(i.code,{children:"sorcerer"}),", ",(0,r.jsx)(i.code,{children:"warlock"}),", ",(0,r.jsx)(i.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:["The ",(0,r.jsx)(i.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(i.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"prerequisites"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of prerequisites that must be met."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"ability_score"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:(0,r.jsx)(i.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"minimum_score"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Minimum score to meet the prerequisite."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"prerequisite_options"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of choices of prerequisites to meet for."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"choose"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"type"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"from"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"proficiencies"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of proficiencies available when multiclassing."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"proficiency_choices"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of choices of proficiencies that are given when multiclassing."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"choose"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"type"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"from"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})})]})]})})]})})})]})]})}function a(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},28453:(e,i,s)=>{s.d(i,{R:()=>c,x:()=>o});var r=s(96540);const t={},n=r.createContext(t);function c(e){const i=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(n.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cd17f53f.5d209dd4.js b/assets/js/cd17f53f.5d209dd4.js deleted file mode 100644 index fbc1ec8..0000000 --- a/assets/js/cd17f53f.5d209dd4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[598],{2523:(e,t,i)=>{i.r(t),i.d(t,{contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var n=i(74848),r=i(28453);const s={},l="Get list of monsters with optional filtering",o={type:"api",id:"get-list-of-monsters-with-optional-filtering",title:"Get list of monsters with optional filtering",description:"",slug:"/get-list-of-monsters-with-optional-filtering",frontMatter:{},api:{tags:["Monsters"],parameters:[{name:"challenge_rating",in:"query",required:!1,description:"The challenge rating or ratings to filter on.",schema:{type:"array",items:{type:"number"}},examples:{"single-value":{value:[1]},"multiple-value":{value:[1,2]},"multiple-value-with-float":{value:[2,.25]}}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get list of monsters with optional filtering",method:"get",path:"/api/monsters",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get list of monsters with optional filtering",description:{type:"text/plain"},url:{path:["api","monsters"],host:["{{baseUrl}}"],query:[{description:{content:"The challenge rating or ratings to filter on.",type:"text/plain"},key:"challenge_rating",value:""},{description:{content:"The challenge rating or ratings to filter on.",type:"text/plain"},key:"challenge_rating",value:""}],variable:[]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-list-of-monsters-with-optional-filtering",previous:{title:"Get a magic school by index.",permalink:"/docs/api/get-a-magic-school-by-index"},next:{title:"Get monster by index.",permalink:"/docs/api/get-monster-by-index"}},c=[];function a(e){const t={h1:"h1",header:"header",p:"p",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"get-list-of-monsters-with-optional-filtering",children:"Get list of monsters with optional filtering"})}),"\n",(0,n.jsx)(t.p,{children:"Get list of monsters with optional filtering"}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"challenge_rating"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number[]"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"The challenge rating or ratings to filter on."})}),(0,n.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,n.jsx)("div",{children:(0,n.jsxs)(t.p,{children:["Example (single-value):\n",(0,n.jsx)("code",{children:"1"})]})}),(0,n.jsx)("div",{children:(0,n.jsxs)(t.p,{children:["Example (multiple-value):\n",(0,n.jsx)("code",{children:"1,2"})]})}),(0,n.jsx)("div",{children:(0,n.jsxs)(t.p,{children:["Example (multiple-value-with-float):\n",(0,n.jsx)("code",{children:"2,0.25"})]})})]})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(t.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"count"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"Total number of resources available."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"results"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,t,i)=>{i.d(t,{R:()=>l,x:()=>o});var n=i(96540);const r={},s=n.createContext(r);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cd17f53f.cbd1e5f9.js b/assets/js/cd17f53f.cbd1e5f9.js new file mode 100644 index 0000000..62f028a --- /dev/null +++ b/assets/js/cd17f53f.cbd1e5f9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[598],{2523:(e,t,i)=>{i.r(t),i.d(t,{contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var n=i(74848),s=i(28453);const r={},l="Get list of monsters with optional filtering",o={type:"api",id:"get-list-of-monsters-with-optional-filtering",title:"Get list of monsters with optional filtering",description:"",slug:"/get-list-of-monsters-with-optional-filtering",frontMatter:{},api:{tags:["Monsters"],parameters:[{name:"challenge_rating",in:"query",required:!1,description:"The challenge rating or ratings to filter on.",schema:{type:"array",items:{type:"number"}},examples:{"single-value":{value:[1]},"multiple-value":{value:[1,2]},"multiple-value-with-float":{value:[2,.25]}}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get list of monsters with optional filtering",method:"get",path:"/api/monsters",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get list of monsters with optional filtering",description:{type:"text/plain"},url:{path:["api","monsters"],host:["{{baseUrl}}"],query:[{description:{content:"The challenge rating or ratings to filter on.",type:"text/plain"},key:"challenge_rating",value:""},{description:{content:"The challenge rating or ratings to filter on.",type:"text/plain"},key:"challenge_rating",value:""}],variable:[]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-list-of-monsters-with-optional-filtering",previous:{title:"Get a magic school by index.",permalink:"/docs/api/get-a-magic-school-by-index"},next:{title:"Get monster by index.",permalink:"/docs/api/get-monster-by-index"}},a=[];function c(e){const t={h1:"h1",header:"header",p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"get-list-of-monsters-with-optional-filtering",children:"Get list of monsters with optional filtering"})}),"\n",(0,n.jsx)(t.p,{children:"Get list of monsters with optional filtering"}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"challenge_rating"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number[]"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"The challenge rating or ratings to filter on."})}),(0,n.jsxs)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:[(0,n.jsx)("div",{children:(0,n.jsxs)(t.p,{children:["Example (single-value):\n",(0,n.jsx)("code",{children:"1"})]})}),(0,n.jsx)("div",{children:(0,n.jsxs)(t.p,{children:["Example (multiple-value):\n",(0,n.jsx)("code",{children:"1,2"})]})}),(0,n.jsx)("div",{children:(0,n.jsxs)(t.p,{children:["Example (multiple-value-with-float):\n",(0,n.jsx)("code",{children:"2,0.25"})]})})]})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(t.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"count"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"Total number of resources available."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"results"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},28453:(e,t,i)=>{i.d(t,{R:()=>l,x:()=>o});var n=i(96540);const s={},r=n.createContext(s);function l(e){const t=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d1a9398a.1d0b391f.js b/assets/js/d1a9398a.1d0b391f.js new file mode 100644 index 0000000..40bf44b --- /dev/null +++ b/assets/js/d1a9398a.1d0b391f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2589],{17604:(e,i,t)=>{t.r(i),t.d(i,{contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var n=t(74848),s=t(28453);const o={},r="Get a magic school by index.",c={type:"api",id:"get-a-magic-school-by-index",title:"Get a magic school by index.",description:"",slug:"/get-a-magic-school-by-index",frontMatter:{},api:{description:"# Magic School\n\nAcademies of magic group spells into eight categories called schools of \nmagic. Scholars, particularly wizards, apply these categories to all spells, \nbelieving that all magic functions in essentially the same way, whether it \nderives from rigorous study or is bestowed by a deity.\n",tags:["Game Mechanics"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the magic school to get.\n",schema:{type:"string",enum:["abjuration","conjuration","divination","enchantment","evocation","illusion","necromancy","transmutation"],example:"abjuration"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`MagicSchool`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Brief description of the resource.",type:"string"}}},example:{index:"conjuration",name:"Conjuration",url:"/api/magic-schools/conjuration",desc:"Conjuration spells involve the transportation of objects and creatures from one location to another. Some spells summon creatures or objects to the caster's side, whereas others allow the caster to teleport to another location. Some conjurations create objects or effects out of nothing."}}}}},method:"get",path:"/api/magic-schools/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a magic school by index.",description:{content:"# Magic School\n\nAcademies of magic group spells into eight categories called schools of \nmagic. Scholars, particularly wizards, apply these categories to all spells, \nbelieving that all magic functions in essentially the same way, whether it \nderives from rigorous study or is bestowed by a deity.\n",type:"text/plain"},url:{path:["api","magic-schools",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the magic school to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-magic-school-by-index",previous:{title:"Get a magic item by index.",permalink:"/docs/api/get-a-magic-item-by-index"},next:{title:"Get list of monsters with optional filtering",permalink:"/docs/api/get-list-of-monsters-with-optional-filtering"}},l=[];function a(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-magic-school-by-index",children:"Get a magic school by index."})}),"\n",(0,n.jsx)(i.h1,{id:"magic-school",children:"Magic School"}),"\n",(0,n.jsx)(i.p,{children:"Academies of magic group spells into eight categories called schools of\nmagic. Scholars, particularly wizards, apply these categories to all spells,\nbelieving that all magic functions in essentially the same way, whether it\nderives from rigorous study or is bestowed by a deity."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"abjuration"}),", ",(0,n.jsx)(i.code,{children:"conjuration"}),", ",(0,n.jsx)(i.code,{children:"divination"}),", ",(0,n.jsx)(i.code,{children:"enchantment"}),", ",(0,n.jsx)(i.code,{children:"evocation"}),", ",(0,n.jsx)(i.code,{children:"illusion"}),", ",(0,n.jsx)(i.code,{children:"necromancy"}),", ",(0,n.jsx)(i.code,{children:"transmutation"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the magic school to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Brief description of the resource."})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>r,x:()=>c});var n=t(96540);const s={},o=n.createContext(s);function r(e){const i=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),n.createElement(o.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d1a9398a.c6d0cebd.js b/assets/js/d1a9398a.c6d0cebd.js deleted file mode 100644 index 828bd4c..0000000 --- a/assets/js/d1a9398a.c6d0cebd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2589],{17604:(e,i,t)=>{t.r(i),t.d(i,{contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var n=t(74848),s=t(28453);const o={},r="Get a magic school by index.",c={type:"api",id:"get-a-magic-school-by-index",title:"Get a magic school by index.",description:"",slug:"/get-a-magic-school-by-index",frontMatter:{},api:{description:"# Magic School\n\nAcademies of magic group spells into eight categories called schools of \nmagic. Scholars, particularly wizards, apply these categories to all spells, \nbelieving that all magic functions in essentially the same way, whether it \nderives from rigorous study or is bestowed by a deity.\n",tags:["Game Mechanics"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the magic school to get.\n",schema:{type:"string",enum:["abjuration","conjuration","divination","enchantment","evocation","illusion","necromancy","transmutation"],example:"abjuration"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`MagicSchool`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Brief description of the resource.",type:"string"}}},example:{index:"conjuration",name:"Conjuration",url:"/api/magic-schools/conjuration",desc:"Conjuration spells involve the transportation of objects and creatures from one location to another. Some spells summon creatures or objects to the caster's side, whereas others allow the caster to teleport to another location. Some conjurations create objects or effects out of nothing."}}}}},method:"get",path:"/api/magic-schools/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a magic school by index.",description:{content:"# Magic School\n\nAcademies of magic group spells into eight categories called schools of \nmagic. Scholars, particularly wizards, apply these categories to all spells, \nbelieving that all magic functions in essentially the same way, whether it \nderives from rigorous study or is bestowed by a deity.\n",type:"text/plain"},url:{path:["api","magic-schools",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the magic school to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-magic-school-by-index",previous:{title:"Get a magic item by index.",permalink:"/docs/api/get-a-magic-item-by-index"},next:{title:"Get list of monsters with optional filtering",permalink:"/docs/api/get-list-of-monsters-with-optional-filtering"}},l=[];function a(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-magic-school-by-index",children:"Get a magic school by index."})}),"\n",(0,n.jsx)(i.h1,{id:"magic-school",children:"Magic School"}),"\n",(0,n.jsx)(i.p,{children:"Academies of magic group spells into eight categories called schools of\nmagic. Scholars, particularly wizards, apply these categories to all spells,\nbelieving that all magic functions in essentially the same way, whether it\nderives from rigorous study or is bestowed by a deity."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"abjuration"}),", ",(0,n.jsx)(i.code,{children:"conjuration"}),", ",(0,n.jsx)(i.code,{children:"divination"}),", ",(0,n.jsx)(i.code,{children:"enchantment"}),", ",(0,n.jsx)(i.code,{children:"evocation"}),", ",(0,n.jsx)(i.code,{children:"illusion"}),", ",(0,n.jsx)(i.code,{children:"necromancy"}),", ",(0,n.jsx)(i.code,{children:"transmutation"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the magic school to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Brief description of the resource."})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>r,x:()=>c});var n=t(96540);const s={},o=n.createContext(s);function r(e){const i=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),n.createElement(o.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/daa8ef3b.41198f39.js b/assets/js/daa8ef3b.41198f39.js deleted file mode 100644 index f8aff94..0000000 --- a/assets/js/daa8ef3b.41198f39.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1635],{99384:(e,i,s)=>{s.r(i),s.d(i,{contentTitle:()=>l,default:()=>d,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var r=s(74848),n=s(28453);const t={},l="Get a class by index.",o={type:"api",id:"get-a-class-by-index",title:"Get a class by index.",description:"",slug:"/get-a-class-by-index",frontMatter:{},api:{description:"# Class\n\nA character class is a fundamental part of the identity and nature of\ncharacters in the Dungeons & Dragons role-playing game. A character's\ncapabilities, strengths, and weaknesses are largely defined by its class.\nA character's class affects a character's available skills and abilities. [[SRD p8-55](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=8)]\n",tags:["Class"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Class`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},hit_die:{description:"Hit die of the class. (ex: 12 == 1d12).",type:"number"},class_levels:{description:"URL of the level resource for the class.",type:"string"},multi_classing:{description:"`Multiclassing`\n",type:"object",properties:{prerequisites:{description:"List of prerequisites that must be met.",type:"array",items:{description:"`Prerequisite`\n",type:"object",properties:{ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},minimum_score:{description:"Minimum score to meet the prerequisite.",type:"number"}}}},prerequisite_options:{description:"List of choices of prerequisites to meet for.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}},proficiencies:{description:"List of proficiencies available when multiclassing.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},proficiency_choices:{description:"List of choices of proficiencies that are given when multiclassing.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}}}},spellcasting:{type:"object",description:"`Spellcasting`\n",properties:{level:{description:"Level at which the class can start using its spellcasting abilities.",type:"number"},info:{description:"Descriptions of the class' ability to cast spells.",type:"array",items:{type:"object",properties:{name:{description:"Feature name.",type:"string"},desc:{description:"Feature description.",type:"array",items:{type:"string"}}}}},spellcasting_ability:{description:"Reference to the `AbilityScore` used for spellcasting by the class.",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},spells:{description:"URL of the spell resource list for the class.",type:"string"},starting_equipment:{description:"List of equipment and their quantities all players of the class start with.",type:"array",items:{type:"object",properties:{quantity:{type:"number"},equipment:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},starting_equipment_options:{description:"List of choices of starting equipment.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}},proficiency_choices:{description:"List of choices of starting proficiencies.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}},proficiencies:{description:"List of starting proficiencies for all new characters of this class.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},saving_throws:{description:"Saving throws the class is proficient in.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},subclasses:{description:"List of all possible subclasses this class can specialize in.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{class_levels:"/api/classes/barbarian/levels",hit_die:12,index:"barbarian",multi_classing:{prerequisites:[{ability_score:{index:"str",name:"STR",url:"/api/ability-scores/str"},minimum_score:13}],proficiencies:[{index:"shields",name:"Shields",url:"/api/proficiencies/shields"},{index:"simple-weapons",name:"Simple Weapons",url:"/api/proficiencies/simple-weapons"},{index:"martial-weapons",name:"Martial Weapons",url:"/api/proficiencies/martial-weapons"}],proficiency_choices:[]},name:"Barbarian",proficiencies:[{index:"light-armor",name:"Light Armor",url:"/api/proficiencies/light-armor"},{index:"medium-armor",name:"Medium Armor",url:"/api/proficiencies/medium-armor"},{index:"shields",name:"Shields",url:"/api/proficiencies/shields"},{index:"simple-weapons",name:"Simple Weapons",url:"/api/proficiencies/simple-weapons"},{index:"martial-weapons",name:"Martial Weapons",url:"/api/proficiencies/martial-weapons"}],proficiency_choices:[{desc:"Choose two from Animal Handling, Athletics, Intimidation, Nature, Perception, and Survival",choose:2,type:"proficiencies",from:{option_set_type:"options_array",options:[{option_type:"reference",item:{index:"skill-animal-handling",name:"Skill: Animal Handling",url:"/api/proficiencies/skill-animal-handling"}},{option_type:"reference",item:{index:"skill-athletics",name:"Skill: Athletics",url:"/api/proficiencies/skill-athletics"}},{option_type:"reference",item:{index:"skill-intimidation",name:"Skill: Intimidation",url:"/api/proficiencies/skill-intimidation"}},{option_type:"reference",item:{index:"skill-nature",name:"Skill: Nature",url:"/api/proficiencies/skill-nature"}},{option_type:"reference",item:{index:"skill-perception",name:"Skill: Perception",url:"/api/proficiencies/skill-perception"}},{option_type:"reference",item:{index:"skill-survival",name:"Skill: Survival",url:"/api/proficiencies/skill-survival"}}]}}],saving_throws:[{index:"str",name:"STR",url:"/api/ability-scores/str"},{index:"con",name:"CON",url:"/api/ability-scores/con"}],starting_equipment:[{equipment:{index:"explorers-pack",name:"Explorer's Pack",url:"/api/equipment/explorers-pack"},quantity:1},{equipment:{index:"javelin",name:"Javelin",url:"/api/equipment/javelin"},quantity:4}],starting_equipment_options:[{desc:"(a) a greataxe or (b) any martial melee weapon",choose:1,type:"equipment",from:{option_set_type:"options_array",options:[{option_type:"counted_reference",count:1,of:{index:"greataxe",name:"Greataxe",url:"/api/equipment/greataxe"}},{option_type:"choice",choice:{desc:"any martial melee weapon",choose:1,type:"equipment",from:{option_set_type:"equipment_category",equipment_category:{index:"martial-melee-weapons",name:"Martial Melee Weapons",url:"/api/equipment-categories/martial-melee-weapons"}}}}]}},{desc:"(a) two handaxes or (b) any simple weapon",choose:1,type:"equipment",from:{option_set_type:"options_array",options:[{option_type:"counted_reference",count:2,of:{index:"handaxe",name:"Handaxe",url:"/api/equipment/handaxe"}},{option_type:"choice",choice:{desc:"any simple weapon",choose:1,type:"equipment",from:{option_set_type:"equipment_category",equipment_category:{index:"simple-weapons",name:"Simple Weapons",url:"/api/equipment-categories/simple-weapons"}}}}]}}],subclasses:[{index:"berserker",name:"Berserker",url:"/api/subclasses/berserker"}],url:"/api/classes/barbarian"}}}}},method:"get",path:"/api/classes/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a class by index.",description:{content:"# Class\n\nA character class is a fundamental part of the identity and nature of\ncharacters in the Dungeons & Dragons role-playing game. A character's\ncapabilities, strengths, and weaknesses are largely defined by its class.\nA character's class affects a character's available skills and abilities. [[SRD p8-55](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=8)]\n",type:"text/plain"},url:{path:["api","classes",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-class-by-index",previous:{title:"Get a background by index.",permalink:"/docs/api/get-a-background-by-index"},next:{title:"Get subclasses available for a class.",permalink:"/docs/api/get-subclasses-available-for-a-class"}},c=[];function a(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"get-a-class-by-index",children:"Get a class by index."})}),"\n",(0,r.jsx)(i.h1,{id:"class",children:"Class"}),"\n",(0,r.jsxs)(i.p,{children:["A character class is a fundamental part of the identity and nature of\ncharacters in the Dungeons & Dragons role-playing game. A character's\ncapabilities, strengths, and weaknesses are largely defined by its class.\nA character's class affects a character's available skills and abilities. [",(0,r.jsx)(i.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=8",children:"SRD p8-55"}),"]"]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"Possible values:"})," [",(0,r.jsx)(i.code,{children:"barbarian"}),", ",(0,r.jsx)(i.code,{children:"bard"}),", ",(0,r.jsx)(i.code,{children:"cleric"}),", ",(0,r.jsx)(i.code,{children:"druid"}),", ",(0,r.jsx)(i.code,{children:"fighter"}),", ",(0,r.jsx)(i.code,{children:"monk"}),", ",(0,r.jsx)(i.code,{children:"paladin"}),", ",(0,r.jsx)(i.code,{children:"ranger"}),", ",(0,r.jsx)(i.code,{children:"rogue"}),", ",(0,r.jsx)(i.code,{children:"sorcerer"}),", ",(0,r.jsx)(i.code,{children:"warlock"}),", ",(0,r.jsx)(i.code,{children:"wizard"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:["The ",(0,r.jsx)(i.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(i.p,{children:"OK"})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"hit_die"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Hit die of the class. (ex: 12 == 1d12)."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"class_levels"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the level resource for the class."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"multi_classing"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:(0,r.jsx)(i.code,{children:"Multiclassing"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"prerequisites"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of prerequisites that must be met."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"ability_score"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:(0,r.jsx)(i.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"minimum_score"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Minimum score to meet the prerequisite."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"prerequisite_options"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of choices of prerequisites to meet for."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"choose"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"type"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"from"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"proficiencies"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of proficiencies available when multiclassing."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"proficiency_choices"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of choices of proficiencies that are given when multiclassing."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"choose"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"type"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"from"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"spellcasting"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:(0,r.jsx)(i.code,{children:"Spellcasting"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level at which the class can start using its spellcasting abilities."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"info"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Descriptions of the class' ability to cast spells."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Feature name."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Feature description."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"spellcasting_ability"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(i.p,{children:["Reference to the ",(0,r.jsx)(i.code,{children:"AbilityScore"})," used for spellcasting by the class."]})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"spells"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the spell resource list for the class."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"starting_equipment"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of equipment and their quantities all players of the class start with."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"quantity"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"equipment"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:(0,r.jsx)(i.code,{children:"APIReference"})})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"starting_equipment_options"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of choices of starting equipment."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"choose"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"type"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"from"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"proficiency_choices"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of choices of starting proficiencies."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"desc"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"choose"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"type"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"from"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"proficiencies"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of starting proficiencies for all new characters of this class."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"saving_throws"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Saving throws the class is proficient in."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"subclasses"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"List of all possible subclasses this class can specialize in."})}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},28453:(e,i,s)=>{s.d(i,{R:()=>l,x:()=>o});var r=s(96540);const n={},t=r.createContext(n);function l(e){const i=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/daa8ef3b.c8d2bcb3.js b/assets/js/daa8ef3b.c8d2bcb3.js new file mode 100644 index 0000000..cdc3ded --- /dev/null +++ b/assets/js/daa8ef3b.c8d2bcb3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1635],{99384:(e,i,s)=>{s.r(i),s.d(i,{contentTitle:()=>l,default:()=>d,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var n=s(74848),r=s(28453);const t={},l="Get a class by index.",o={type:"api",id:"get-a-class-by-index",title:"Get a class by index.",description:"",slug:"/get-a-class-by-index",frontMatter:{},api:{description:"# Class\n\nA character class is a fundamental part of the identity and nature of\ncharacters in the Dungeons & Dragons role-playing game. A character's\ncapabilities, strengths, and weaknesses are largely defined by its class.\nA character's class affects a character's available skills and abilities. [[SRD p8-55](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=8)]\n",tags:["Class"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Class`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},hit_die:{description:"Hit die of the class. (ex: 12 == 1d12).",type:"number"},class_levels:{description:"URL of the level resource for the class.",type:"string"},multi_classing:{description:"`Multiclassing`\n",type:"object",properties:{prerequisites:{description:"List of prerequisites that must be met.",type:"array",items:{description:"`Prerequisite`\n",type:"object",properties:{ability_score:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},minimum_score:{description:"Minimum score to meet the prerequisite.",type:"number"}}}},prerequisite_options:{description:"List of choices of prerequisites to meet for.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}},proficiencies:{description:"List of proficiencies available when multiclassing.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},proficiency_choices:{description:"List of choices of proficiencies that are given when multiclassing.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}}}},spellcasting:{type:"object",description:"`Spellcasting`\n",properties:{level:{description:"Level at which the class can start using its spellcasting abilities.",type:"number"},info:{description:"Descriptions of the class' ability to cast spells.",type:"array",items:{type:"object",properties:{name:{description:"Feature name.",type:"string"},desc:{description:"Feature description.",type:"array",items:{type:"string"}}}}},spellcasting_ability:{description:"Reference to the `AbilityScore` used for spellcasting by the class.",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},spells:{description:"URL of the spell resource list for the class.",type:"string"},starting_equipment:{description:"List of equipment and their quantities all players of the class start with.",type:"array",items:{type:"object",properties:{quantity:{type:"number"},equipment:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},starting_equipment_options:{description:"List of choices of starting equipment.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}},proficiency_choices:{description:"List of choices of starting proficiencies.",type:"array",items:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}}},proficiencies:{description:"List of starting proficiencies for all new characters of this class.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},saving_throws:{description:"Saving throws the class is proficient in.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},subclasses:{description:"List of all possible subclasses this class can specialize in.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},example:{class_levels:"/api/classes/barbarian/levels",hit_die:12,index:"barbarian",multi_classing:{prerequisites:[{ability_score:{index:"str",name:"STR",url:"/api/ability-scores/str"},minimum_score:13}],proficiencies:[{index:"shields",name:"Shields",url:"/api/proficiencies/shields"},{index:"simple-weapons",name:"Simple Weapons",url:"/api/proficiencies/simple-weapons"},{index:"martial-weapons",name:"Martial Weapons",url:"/api/proficiencies/martial-weapons"}],proficiency_choices:[]},name:"Barbarian",proficiencies:[{index:"light-armor",name:"Light Armor",url:"/api/proficiencies/light-armor"},{index:"medium-armor",name:"Medium Armor",url:"/api/proficiencies/medium-armor"},{index:"shields",name:"Shields",url:"/api/proficiencies/shields"},{index:"simple-weapons",name:"Simple Weapons",url:"/api/proficiencies/simple-weapons"},{index:"martial-weapons",name:"Martial Weapons",url:"/api/proficiencies/martial-weapons"}],proficiency_choices:[{desc:"Choose two from Animal Handling, Athletics, Intimidation, Nature, Perception, and Survival",choose:2,type:"proficiencies",from:{option_set_type:"options_array",options:[{option_type:"reference",item:{index:"skill-animal-handling",name:"Skill: Animal Handling",url:"/api/proficiencies/skill-animal-handling"}},{option_type:"reference",item:{index:"skill-athletics",name:"Skill: Athletics",url:"/api/proficiencies/skill-athletics"}},{option_type:"reference",item:{index:"skill-intimidation",name:"Skill: Intimidation",url:"/api/proficiencies/skill-intimidation"}},{option_type:"reference",item:{index:"skill-nature",name:"Skill: Nature",url:"/api/proficiencies/skill-nature"}},{option_type:"reference",item:{index:"skill-perception",name:"Skill: Perception",url:"/api/proficiencies/skill-perception"}},{option_type:"reference",item:{index:"skill-survival",name:"Skill: Survival",url:"/api/proficiencies/skill-survival"}}]}}],saving_throws:[{index:"str",name:"STR",url:"/api/ability-scores/str"},{index:"con",name:"CON",url:"/api/ability-scores/con"}],starting_equipment:[{equipment:{index:"explorers-pack",name:"Explorer's Pack",url:"/api/equipment/explorers-pack"},quantity:1},{equipment:{index:"javelin",name:"Javelin",url:"/api/equipment/javelin"},quantity:4}],starting_equipment_options:[{desc:"(a) a greataxe or (b) any martial melee weapon",choose:1,type:"equipment",from:{option_set_type:"options_array",options:[{option_type:"counted_reference",count:1,of:{index:"greataxe",name:"Greataxe",url:"/api/equipment/greataxe"}},{option_type:"choice",choice:{desc:"any martial melee weapon",choose:1,type:"equipment",from:{option_set_type:"equipment_category",equipment_category:{index:"martial-melee-weapons",name:"Martial Melee Weapons",url:"/api/equipment-categories/martial-melee-weapons"}}}}]}},{desc:"(a) two handaxes or (b) any simple weapon",choose:1,type:"equipment",from:{option_set_type:"options_array",options:[{option_type:"counted_reference",count:2,of:{index:"handaxe",name:"Handaxe",url:"/api/equipment/handaxe"}},{option_type:"choice",choice:{desc:"any simple weapon",choose:1,type:"equipment",from:{option_set_type:"equipment_category",equipment_category:{index:"simple-weapons",name:"Simple Weapons",url:"/api/equipment-categories/simple-weapons"}}}}]}}],subclasses:[{index:"berserker",name:"Berserker",url:"/api/subclasses/berserker"}],url:"/api/classes/barbarian"}}}}},method:"get",path:"/api/classes/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get a class by index.",description:{content:"# Class\n\nA character class is a fundamental part of the identity and nature of\ncharacters in the Dungeons & Dragons role-playing game. A character's\ncapabilities, strengths, and weaknesses are largely defined by its class.\nA character's class affects a character's available skills and abilities. [[SRD p8-55](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=8)]\n",type:"text/plain"},url:{path:["api","classes",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-a-class-by-index",previous:{title:"Get a background by index.",permalink:"/docs/api/get-a-background-by-index"},next:{title:"Get subclasses available for a class.",permalink:"/docs/api/get-subclasses-available-for-a-class"}},c=[];function a(e){const i={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-a-class-by-index",children:"Get a class by index."})}),"\n",(0,n.jsx)(i.h1,{id:"class",children:"Class"}),"\n",(0,n.jsxs)(i.p,{children:["A character class is a fundamental part of the identity and nature of\ncharacters in the Dungeons & Dragons role-playing game. A character's\ncapabilities, strengths, and weaknesses are largely defined by its class.\nA character's class affects a character's available skills and abilities. [",(0,n.jsx)(i.a,{href:"https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=8",children:"SRD p8-55"}),"]"]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"barbarian"}),", ",(0,n.jsx)(i.code,{children:"bard"}),", ",(0,n.jsx)(i.code,{children:"cleric"}),", ",(0,n.jsx)(i.code,{children:"druid"}),", ",(0,n.jsx)(i.code,{children:"fighter"}),", ",(0,n.jsx)(i.code,{children:"monk"}),", ",(0,n.jsx)(i.code,{children:"paladin"}),", ",(0,n.jsx)(i.code,{children:"ranger"}),", ",(0,n.jsx)(i.code,{children:"rogue"}),", ",(0,n.jsx)(i.code,{children:"sorcerer"}),", ",(0,n.jsx)(i.code,{children:"warlock"}),", ",(0,n.jsx)(i.code,{children:"wizard"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"hit_die"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Hit die of the class. (ex: 12 == 1d12)."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"class_levels"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the level resource for the class."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"multi_classing"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Multiclassing"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"prerequisites"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of prerequisites that must be met."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability_score"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"minimum_score"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Minimum score to meet the prerequisite."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"prerequisite_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of choices of prerequisites to meet for."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"proficiencies"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of proficiencies available when multiclassing."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"proficiency_choices"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of choices of proficiencies that are given when multiclassing."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spellcasting"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Spellcasting"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level at which the class can start using its spellcasting abilities."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"info"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Descriptions of the class' ability to cast spells."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Feature name."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Feature description."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spellcasting_ability"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["Reference to the ",(0,n.jsx)(i.code,{children:"AbilityScore"})," used for spellcasting by the class."]})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spells"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the spell resource list for the class."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_equipment"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of equipment and their quantities all players of the class start with."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"quantity"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"equipment"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"starting_equipment_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of choices of starting equipment."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"proficiency_choices"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of choices of starting proficiencies."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"proficiencies"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of starting proficiencies for all new characters of this class."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"saving_throws"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Saving throws the class is proficient in."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"subclasses"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of all possible subclasses this class can specialize in."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,i,s)=>{s.d(i,{R:()=>l,x:()=>o});var n=s(96540);const r={},t=n.createContext(r);function l(e){const i=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),n.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ddff8a46.41ab7e8d.js b/assets/js/ddff8a46.41ab7e8d.js new file mode 100644 index 0000000..f5c422c --- /dev/null +++ b/assets/js/ddff8a46.41ab7e8d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1932],{45817:(e,s,i)=>{i.r(s),i.d(s,{contentTitle:()=>r,default:()=>d,frontMatter:()=>n,metadata:()=>a,toc:()=>o});var l=i(74848),t=i(28453);const n={},r="Get spellcasting info for a class.",a={type:"api",id:"get-spellcasting-info-for-a-class",title:"Get spellcasting info for a class.",description:"",slug:"/get-spellcasting-info-for-a-class",frontMatter:{},api:{tags:["Class"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{type:"object",description:"`Spellcasting`\n",properties:{level:{description:"Level at which the class can start using its spellcasting abilities.",type:"number"},info:{description:"Descriptions of the class' ability to cast spells.",type:"array",items:{type:"object",properties:{name:{description:"Feature name.",type:"string"},desc:{description:"Feature description.",type:"array",items:{type:"string"}}}}},spellcasting_ability:{description:"Reference to the `AbilityScore` used for spellcasting by the class.",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},example:{level:1,spellcasting_ability:{index:"cha",name:"CHA",url:"/api/ability-scores/cha"},info:[{name:"Cantrips",desc:["You know two cantrips of your choice from the bard spell list. You learn additional bard cantrips of your choice at higher levels, as shown in the Cantrips Known column of the Bard table."]},{name:"Spell Slots",desc:["The Bard table shows how many spell slots you have to cast your spells of 1st level and higher. To cast one of these spells, you must expend a slot of the spell's level or higher. You regain all expended spell slots when you finish a long rest.","For example, if you know the 1st-level spell cure wounds and have a 1st-level and a 2nd-level spell slot available, you can cast cure wounds using either slot."]},{name:"Spells Known of 1st Level and Higher",desc:["You know four 1st-level spells of your choice from the bard spell list.","The Spells Known column of the Bard table shows when you learn more bard spells of your choice.","Each of these spells must be of a level for which you have spell slots, as shown on the table. For instance, when you reach 3rd level in this class, you can learn one new spell of 1st or 2nd level.","Additionally, when you gain a level in this class, you can choose one of the bard spells you know and replace it with another spell from the bard spell list, which also must be of a level for which you have spell slots."]},{name:"Spellcasting Ability",desc:["Charisma is your spellcasting ability for your bard spells. Your magic comes from the heart and soul you pour into the performance of your music or oration. You use your Charisma whenever a spell refers to your spellcasting ability. In addition, you use your Charisma modifier when setting the saving throw DC for a bard spell you cast and when making an attack roll with one.","Spell save DC = 8 + your proficiency bonus + your Charisma modifier.","Spell attack modifier = your proficiency bonus + your Charisma modifier."]},{name:"Ritual Casting",desc:["You can cast any bard spell you know as a ritual if that spell has the ritual tag."]},{name:"Spellcasting Focus",desc:["You can use a musical instrument (see Equipment) as a spellcasting focus for your bard spells."]}]}}}},404:{description:"Not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}},required:["error"]},example:{error:"Not found"}}}}},description:"Get spellcasting info for a class.",method:"get",path:"/api/classes/{index}/spellcasting",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get spellcasting info for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","spellcasting"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-spellcasting-info-for-a-class",previous:{title:"Get spells available for a class.",permalink:"/docs/api/get-spells-available-for-a-class"},next:{title:"Get features available for a class.",permalink:"/docs/api/get-features-available-for-a-class"}},o=[];function c(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(s.header,{children:(0,l.jsx)(s.h1,{id:"get-spellcasting-info-for-a-class",children:"Get spellcasting info for a class."})}),"\n",(0,l.jsx)(s.p,{children:"Get spellcasting info for a class."}),"\n",(0,l.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,l.jsx)("tbody",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"index"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Possible values:"})," [",(0,l.jsx)(s.code,{children:"barbarian"}),", ",(0,l.jsx)(s.code,{children:"bard"}),", ",(0,l.jsx)(s.code,{children:"cleric"}),", ",(0,l.jsx)(s.code,{children:"druid"}),", ",(0,l.jsx)(s.code,{children:"fighter"}),", ",(0,l.jsx)(s.code,{children:"monk"}),", ",(0,l.jsx)(s.code,{children:"paladin"}),", ",(0,l.jsx)(s.code,{children:"ranger"}),", ",(0,l.jsx)(s.code,{children:"rogue"}),", ",(0,l.jsx)(s.code,{children:"sorcerer"}),", ",(0,l.jsx)(s.code,{children:"warlock"}),", ",(0,l.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:["The ",(0,l.jsx)(s.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,l.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsxs)("div",{style:{display:"flex"},children:[(0,l.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)("code",{children:"200"})}),(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"OK"})})]}),(0,l.jsx)("div",{children:(0,l.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("th",{style:{textAlign:"left"},children:[(0,l.jsx)("span",{children:"Schema "}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{})]})})}),(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"level"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Level at which the class can start using its spellcasting abilities."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"info"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Descriptions of the class' ability to cast spells."})}),(0,l.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"name"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Feature name."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"desc"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Feature description."})})]})})]})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"spellcasting_ability"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:["Reference to the ",(0,l.jsx)(s.code,{children:"AbilityScore"})," used for spellcasting by the class."]})}),(0,l.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"index"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"name"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"url"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsxs)("div",{style:{display:"flex"},children:[(0,l.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)("code",{children:"404"})}),(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Not found."})})]}),(0,l.jsx)("div",{children:(0,l.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("th",{style:{textAlign:"left"},children:[(0,l.jsx)("span",{children:"Schema "}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{})]})})}),(0,l.jsx)("tbody",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"error"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"})]})})})]})})]})})]})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(c,{...e})}):c(e)}},28453:(e,s,i)=>{i.d(s,{R:()=>r,x:()=>a});var l=i(96540);const t={},n=l.createContext(t);function r(e){const s=l.useContext(n);return l.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),l.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ddff8a46.da87a8d7.js b/assets/js/ddff8a46.da87a8d7.js deleted file mode 100644 index 309aed9..0000000 --- a/assets/js/ddff8a46.da87a8d7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1932],{45817:(e,s,i)=>{i.r(s),i.d(s,{contentTitle:()=>r,default:()=>d,frontMatter:()=>n,metadata:()=>a,toc:()=>o});var l=i(74848),t=i(28453);const n={},r="Get spellcasting info for a class.",a={type:"api",id:"get-spellcasting-info-for-a-class",title:"Get spellcasting info for a class.",description:"",slug:"/get-spellcasting-info-for-a-class",frontMatter:{},api:{tags:["Class"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the class to get.\n",schema:{type:"string",enum:["barbarian","bard","cleric","druid","fighter","monk","paladin","ranger","rogue","sorcerer","warlock","wizard"],example:"paladin"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{type:"object",description:"`Spellcasting`\n",properties:{level:{description:"Level at which the class can start using its spellcasting abilities.",type:"number"},info:{description:"Descriptions of the class' ability to cast spells.",type:"array",items:{type:"object",properties:{name:{description:"Feature name.",type:"string"},desc:{description:"Feature description.",type:"array",items:{type:"string"}}}}},spellcasting_ability:{description:"Reference to the `AbilityScore` used for spellcasting by the class.",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},example:{level:1,spellcasting_ability:{index:"cha",name:"CHA",url:"/api/ability-scores/cha"},info:[{name:"Cantrips",desc:["You know two cantrips of your choice from the bard spell list. You learn additional bard cantrips of your choice at higher levels, as shown in the Cantrips Known column of the Bard table."]},{name:"Spell Slots",desc:["The Bard table shows how many spell slots you have to cast your spells of 1st level and higher. To cast one of these spells, you must expend a slot of the spell's level or higher. You regain all expended spell slots when you finish a long rest.","For example, if you know the 1st-level spell cure wounds and have a 1st-level and a 2nd-level spell slot available, you can cast cure wounds using either slot."]},{name:"Spells Known of 1st Level and Higher",desc:["You know four 1st-level spells of your choice from the bard spell list.","The Spells Known column of the Bard table shows when you learn more bard spells of your choice.","Each of these spells must be of a level for which you have spell slots, as shown on the table. For instance, when you reach 3rd level in this class, you can learn one new spell of 1st or 2nd level.","Additionally, when you gain a level in this class, you can choose one of the bard spells you know and replace it with another spell from the bard spell list, which also must be of a level for which you have spell slots."]},{name:"Spellcasting Ability",desc:["Charisma is your spellcasting ability for your bard spells. Your magic comes from the heart and soul you pour into the performance of your music or oration. You use your Charisma whenever a spell refers to your spellcasting ability. In addition, you use your Charisma modifier when setting the saving throw DC for a bard spell you cast and when making an attack roll with one.","Spell save DC = 8 + your proficiency bonus + your Charisma modifier.","Spell attack modifier = your proficiency bonus + your Charisma modifier."]},{name:"Ritual Casting",desc:["You can cast any bard spell you know as a ritual if that spell has the ritual tag."]},{name:"Spellcasting Focus",desc:["You can use a musical instrument (see Equipment) as a spellcasting focus for your bard spells."]}]}}}},404:{description:"Not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}},required:["error"]},example:{error:"Not found"}}}}},description:"Get spellcasting info for a class.",method:"get",path:"/api/classes/{index}/spellcasting",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get spellcasting info for a class.",description:{type:"text/plain"},url:{path:["api","classes",":index","spellcasting"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the class to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-spellcasting-info-for-a-class",previous:{title:"Get spells available for a class.",permalink:"/docs/api/get-spells-available-for-a-class"},next:{title:"Get features available for a class.",permalink:"/docs/api/get-features-available-for-a-class"}},o=[];function c(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(s.header,{children:(0,l.jsx)(s.h1,{id:"get-spellcasting-info-for-a-class",children:"Get spellcasting info for a class."})}),"\n",(0,l.jsx)(s.p,{children:"Get spellcasting info for a class."}),"\n",(0,l.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,l.jsx)("tbody",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"index"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Possible values:"})," [",(0,l.jsx)(s.code,{children:"barbarian"}),", ",(0,l.jsx)(s.code,{children:"bard"}),", ",(0,l.jsx)(s.code,{children:"cleric"}),", ",(0,l.jsx)(s.code,{children:"druid"}),", ",(0,l.jsx)(s.code,{children:"fighter"}),", ",(0,l.jsx)(s.code,{children:"monk"}),", ",(0,l.jsx)(s.code,{children:"paladin"}),", ",(0,l.jsx)(s.code,{children:"ranger"}),", ",(0,l.jsx)(s.code,{children:"rogue"}),", ",(0,l.jsx)(s.code,{children:"sorcerer"}),", ",(0,l.jsx)(s.code,{children:"warlock"}),", ",(0,l.jsx)(s.code,{children:"wizard"}),"]"]})}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:["The ",(0,l.jsx)(s.code,{children:"index"})," of the class to get."]})})]})})})]}),"\n",(0,l.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsxs)("div",{style:{display:"flex"},children:[(0,l.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)("code",{children:"200"})}),(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"OK"})})]}),(0,l.jsx)("div",{children:(0,l.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("th",{style:{textAlign:"left"},children:[(0,l.jsx)("span",{children:"Schema "}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{})]})})}),(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"level"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Level at which the class can start using its spellcasting abilities."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"info"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Descriptions of the class' ability to cast spells."})}),(0,l.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"name"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Feature name."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"desc"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Feature description."})})]})})]})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"spellcasting_ability"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsxs)(s.p,{children:["Reference to the ",(0,l.jsx)(s.code,{children:"AbilityScore"})," used for spellcasting by the class."]})}),(0,l.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"index"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Resource index for shorthand searching."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"level"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Level of the referenced resource."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"name"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"Name of the referenced resource."})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"url"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)(s.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})}),(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsxs)("div",{style:{display:"flex"},children:[(0,l.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,l.jsx)("code",{children:"404"})}),(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Not found."})})]}),(0,l.jsx)("div",{children:(0,l.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,l.jsx)("thead",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("th",{style:{textAlign:"left"},children:[(0,l.jsx)("span",{children:"Schema "}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,l.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,l.jsx)("div",{})]})})}),(0,l.jsx)("tbody",{children:(0,l.jsx)("tr",{children:(0,l.jsxs)("td",{children:[(0,l.jsx)("code",{children:"error"}),(0,l.jsx)("span",{style:{opacity:"0.6"},children:" string"})]})})})]})})]})})]})]})]})}function d(e){void 0===e&&(e={});const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(c,{...e})}):c(e)}},28453:(e,s,i)=>{i.d(s,{R:()=>r,x:()=>a});var l=i(96540);const t={},n=l.createContext(t);function r(e){const s=l.useContext(n);return l.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),l.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/df53a957.2724bda0.js b/assets/js/df53a957.2724bda0.js new file mode 100644 index 0000000..ab95f8d --- /dev/null +++ b/assets/js/df53a957.2724bda0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4819],{75002:(e,r,i)=>{i.r(r),i.d(r,{contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var n=i(74848),t=i(28453);const s={},a="Get subraces available for a race.",c={type:"api",id:"get-subraces-available-for-a-race",title:"Get subraces available for a race.",description:"",slug:"/get-subraces-available-for-a-race",frontMatter:{},api:{tags:["Races"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the race to get.\n",schema:{type:"string",enum:["dragonborn","dwarf","elf","gnome","half-elf","half-orc","halfling","human","tiefling"],example:"elf"}}],responses:{200:{description:"List of subraces for the race.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get subraces available for a race.",method:"get",path:"/api/races/{index}/subraces",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get subraces available for a race.",description:{type:"text/plain"},url:{path:["api","races",":index","subraces"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the race to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-subraces-available-for-a-race",previous:{title:"Get a race by index.",permalink:"/docs/api/get-a-race-by-index"},next:{title:"Get proficiencies available for a race.",permalink:"/docs/api/get-proficiencies-available-for-a-race"}},l=[];function o(e){const r={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"get-subraces-available-for-a-race",children:"Get subraces available for a race."})}),"\n",(0,n.jsx)(r.p,{children:"Get subraces available for a race."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Possible values:"})," [",(0,n.jsx)(r.code,{children:"dragonborn"}),", ",(0,n.jsx)(r.code,{children:"dwarf"}),", ",(0,n.jsx)(r.code,{children:"elf"}),", ",(0,n.jsx)(r.code,{children:"gnome"}),", ",(0,n.jsx)(r.code,{children:"half-elf"}),", ",(0,n.jsx)(r.code,{children:"half-orc"}),", ",(0,n.jsx)(r.code,{children:"halfling"}),", ",(0,n.jsx)(r.code,{children:"human"}),", ",(0,n.jsx)(r.code,{children:"tiefling"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(r.p,{children:["The ",(0,n.jsx)(r.code,{children:"index"})," of the race to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(r.p,{children:"List of subraces for the race."})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"count"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(r.p,{children:"Total number of resources available."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"results"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(r.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(r.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(r.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},28453:(e,r,i)=>{i.d(r,{R:()=>a,x:()=>c});var n=i(96540);const t={},s=n.createContext(t);function a(e){const r=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),n.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/df53a957.3fa60423.js b/assets/js/df53a957.3fa60423.js deleted file mode 100644 index b61c748..0000000 --- a/assets/js/df53a957.3fa60423.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4819],{75002:(e,r,i)=>{i.r(r),i.d(r,{contentTitle:()=>a,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var n=i(74848),s=i(28453);const t={},a="Get subraces available for a race.",l={type:"api",id:"get-subraces-available-for-a-race",title:"Get subraces available for a race.",description:"",slug:"/get-subraces-available-for-a-race",frontMatter:{},api:{tags:["Races"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the race to get.\n",schema:{type:"string",enum:["dragonborn","dwarf","elf","gnome","half-elf","half-orc","halfling","human","tiefling"],example:"elf"}}],responses:{200:{description:"List of subraces for the race.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get subraces available for a race.",method:"get",path:"/api/races/{index}/subraces",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get subraces available for a race.",description:{type:"text/plain"},url:{path:["api","races",":index","subraces"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the race to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-subraces-available-for-a-race",previous:{title:"Get a race by index.",permalink:"/docs/api/get-a-race-by-index"},next:{title:"Get proficiencies available for a race.",permalink:"/docs/api/get-proficiencies-available-for-a-race"}},c=[];function o(e){const r={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"get-subraces-available-for-a-race",children:"Get subraces available for a race."})}),"\n",(0,n.jsx)(r.p,{children:"Get subraces available for a race."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Possible values:"})," [",(0,n.jsx)(r.code,{children:"dragonborn"}),", ",(0,n.jsx)(r.code,{children:"dwarf"}),", ",(0,n.jsx)(r.code,{children:"elf"}),", ",(0,n.jsx)(r.code,{children:"gnome"}),", ",(0,n.jsx)(r.code,{children:"half-elf"}),", ",(0,n.jsx)(r.code,{children:"half-orc"}),", ",(0,n.jsx)(r.code,{children:"halfling"}),", ",(0,n.jsx)(r.code,{children:"human"}),", ",(0,n.jsx)(r.code,{children:"tiefling"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(r.p,{children:["The ",(0,n.jsx)(r.code,{children:"index"})," of the race to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(r.p,{children:"List of subraces for the race."})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"count"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(r.p,{children:"Total number of resources available."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"results"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(r.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(r.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(r.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(r.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},28453:(e,r,i)=>{i.d(r,{R:()=>a,x:()=>l});var n=i(96540);const s={},t=n.createContext(s);function a(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e6ba45fe.3bd940ea.js b/assets/js/e6ba45fe.3bd940ea.js deleted file mode 100644 index 24d5695..0000000 --- a/assets/js/e6ba45fe.3bd940ea.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5503],{73629:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>a});var n=r(74848),t=r(28453);const s={},c="Get proficiencies available for a race.",l={type:"api",id:"get-proficiencies-available-for-a-race",title:"Get proficiencies available for a race.",description:"",slug:"/get-proficiencies-available-for-a-race",frontMatter:{},api:{tags:["Races"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the race to get.\n",schema:{type:"string",enum:["dragonborn","dwarf","elf","gnome","half-elf","half-orc","halfling","human","tiefling"],example:"elf"}}],responses:{200:{description:"List of proficiencies for the race.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get proficiencies available for a race.",method:"get",path:"/api/races/{index}/proficiencies",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get proficiencies available for a race.",description:{type:"text/plain"},url:{path:["api","races",":index","proficiencies"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the race to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-proficiencies-available-for-a-race",previous:{title:"Get subraces available for a race.",permalink:"/docs/api/get-subraces-available-for-a-race"},next:{title:"Get traits available for a race.",permalink:"/docs/api/get-traits-available-for-a-race"}},a=[];function o(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-proficiencies-available-for-a-race",children:"Get proficiencies available for a race."})}),"\n",(0,n.jsx)(i.p,{children:"Get proficiencies available for a race."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"dragonborn"}),", ",(0,n.jsx)(i.code,{children:"dwarf"}),", ",(0,n.jsx)(i.code,{children:"elf"}),", ",(0,n.jsx)(i.code,{children:"gnome"}),", ",(0,n.jsx)(i.code,{children:"half-elf"}),", ",(0,n.jsx)(i.code,{children:"half-orc"}),", ",(0,n.jsx)(i.code,{children:"halfling"}),", ",(0,n.jsx)(i.code,{children:"human"}),", ",(0,n.jsx)(i.code,{children:"tiefling"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the race to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"List of proficiencies for the race."})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"count"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Total number of resources available."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"results"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>c,x:()=>l});var n=r(96540);const t={},s=n.createContext(t);function c(e){const i=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e6ba45fe.d1790090.js b/assets/js/e6ba45fe.d1790090.js new file mode 100644 index 0000000..cf414d6 --- /dev/null +++ b/assets/js/e6ba45fe.d1790090.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5503],{73629:(e,i,r)=>{r.r(i),r.d(i,{contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var n=r(74848),t=r(28453);const s={},a="Get proficiencies available for a race.",c={type:"api",id:"get-proficiencies-available-for-a-race",title:"Get proficiencies available for a race.",description:"",slug:"/get-proficiencies-available-for-a-race",frontMatter:{},api:{tags:["Races"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the race to get.\n",schema:{type:"string",enum:["dragonborn","dwarf","elf","gnome","half-elf","half-orc","halfling","human","tiefling"],example:"elf"}}],responses:{200:{description:"List of proficiencies for the race.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get proficiencies available for a race.",method:"get",path:"/api/races/{index}/proficiencies",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get proficiencies available for a race.",description:{type:"text/plain"},url:{path:["api","races",":index","proficiencies"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the race to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-proficiencies-available-for-a-race",previous:{title:"Get subraces available for a race.",permalink:"/docs/api/get-subraces-available-for-a-race"},next:{title:"Get traits available for a race.",permalink:"/docs/api/get-traits-available-for-a-race"}},l=[];function o(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-proficiencies-available-for-a-race",children:"Get proficiencies available for a race."})}),"\n",(0,n.jsx)(i.p,{children:"Get proficiencies available for a race."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"dragonborn"}),", ",(0,n.jsx)(i.code,{children:"dwarf"}),", ",(0,n.jsx)(i.code,{children:"elf"}),", ",(0,n.jsx)(i.code,{children:"gnome"}),", ",(0,n.jsx)(i.code,{children:"half-elf"}),", ",(0,n.jsx)(i.code,{children:"half-orc"}),", ",(0,n.jsx)(i.code,{children:"halfling"}),", ",(0,n.jsx)(i.code,{children:"human"}),", ",(0,n.jsx)(i.code,{children:"tiefling"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the race to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"List of proficiencies for the race."})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"count"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Total number of resources available."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"results"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>a,x:()=>c});var n=r(96540);const t={},s=n.createContext(t);function a(e){const i=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),n.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f8b89776.840bac8a.js b/assets/js/f8b89776.840bac8a.js deleted file mode 100644 index 9c6b2e5..0000000 --- a/assets/js/f8b89776.840bac8a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3576],{76438:(e,i,s)=>{s.r(i),s.d(i,{contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var n=s(74848),t=s(28453);const r={},o="Get monster by index.",l={type:"api",id:"get-monster-by-index",title:"Get monster by index.",description:"",slug:"/get-monster-by-index",frontMatter:{},api:{tags:["Monsters"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the `Monster` to get.\n",schema:{type:"string",example:"aboleth"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Monster`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},charisma:{description:"A monster's ability to charm or intimidate a player.",type:"number"},constitution:{description:'How sturdy a monster is."',type:"number"},dexterity:{description:"The monster's ability for swift movement or stealth",type:"number"},intelligence:{description:"The monster's ability to outsmart a player.",type:"number"},strength:{description:"How hard a monster can hit a player.",type:"number"},wisdom:{description:"A monster's ability to ascertain the player's plan.",type:"number"},image:{description:"The image url of the monster.",type:"string"},size:{description:'The size of the monster ranging from Tiny to Gargantuan."',type:"string",enum:["Tiny","Small","Medium","Large","Huge","Gargantuan"]},type:{description:"The type of monster.",type:"string"},subtype:{description:'The sub-category of a monster used for classification of monsters."',type:"string"},alignments:{description:"A creature's general moral and personal attitudes.",type:"string",enum:["chaotic neutral","chaotic evil","chaotic good","lawful neutral","lawful evil","lawful good","neutral","neutral evil","neutral good","any alignment","unaligned"]},armor_class:{description:"The difficulty for a player to successfully deal damage to a monster.",type:"array",items:{description:"The armor class of a monster.",type:"object",oneOf:[{type:"object",properties:{type:{type:"string",enum:["dex"]},value:{type:"number"},desc:{type:"string"}}},{type:"object",properties:{type:{type:"string",enum:["natural"]},value:{type:"number"},desc:{type:"string"}}},{type:"object",properties:{type:{type:"string",enum:["armor"]},value:{type:"number"},armor:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},desc:{type:"string"}}},{type:"object",properties:{type:{type:"string",enum:["spell"]},value:{type:"number"},spell:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},desc:{type:"string"}}},{type:"object",properties:{type:{type:"string",enum:["condition"]},value:{type:"number"},condition:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},desc:{type:"string"}}}]}},hit_points:{description:"The hit points of a monster determine how much damage it is able to take before it can be defeated.",type:"number"},hit_dice:{description:"The hit die of a monster can be used to make a version of the same monster whose hit points are determined by the roll of the die. For example: A monster with 2d6 would have its hit points determine by rolling a 6 sided die twice.",type:"string"},hit_points_roll:{description:"The roll for determining a monster's hit points, which consists of the hit dice (e.g. 18d10) and the modifier determined by its Constitution (e.g. +36). For example, 18d10+36",type:"string"},actions:{description:"A list of actions that are available to the monster to take during combat.",type:"array",items:{description:"Action available to a `Monster` in addition to the standard creature actions.",type:"object",properties:{name:{type:"string"},desc:{type:"string"},action_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},actions:{type:"array",items:{type:"object",properties:{action_name:{type:"string"},count:{type:"number"},type:{type:"string",enum:["melee","ranged","ability","magic"]}}}},options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},multiattack_type:{type:"string"},attack_bonus:{type:"number"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},attacks:{type:"array",items:{type:"object",properties:{name:{type:"string"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}},damage:{type:"array",items:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}},legendary_actions:{description:"A list of legendary actions that are available to the monster to take during combat.",type:"array",items:{description:"Action available to a `Monster` in addition to the standard creature actions.",type:"object",properties:{name:{type:"string"},desc:{type:"string"},action_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},actions:{type:"array",items:{type:"object",properties:{action_name:{type:"string"},count:{type:"number"},type:{type:"string",enum:["melee","ranged","ability","magic"]}}}},options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},multiattack_type:{type:"string"},attack_bonus:{type:"number"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},attacks:{type:"array",items:{type:"object",properties:{name:{type:"string"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}},damage:{type:"array",items:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}},challenge_rating:{description:"A monster's challenge rating is a guideline number that says when a monster becomes an appropriate challenge against the party's average level. For example. A group of 4 players with an average level of 4 would have an appropriate combat challenge against a monster with a challenge rating of 4 but a monster with a challenge rating of 8 against the same group of players would pose a significant threat.",type:"number",minimum:0,maximum:21},condition_immunities:{description:"A list of conditions that a monster is immune to.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},damage_immunities:{description:"A list of damage types that a monster will take double damage from.",type:"array",items:{type:"string"}},damage_resistances:{description:"A list of damage types that a monster will take half damage from.",type:"array",items:{type:"string"}},damage_vulnerabilities:{description:"A list of damage types that a monster will take double damage from.",type:"array",items:{type:"string"}},forms:{description:"List of other related monster entries that are of the same form. Only applicable to Lycanthropes that have multiple forms.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},languages:{description:"The languages a monster is able to speak.",type:"string"},proficiencies:{description:"A list of proficiencies of a monster.",type:"array",items:{type:"object",properties:{value:{type:"number"},proficiency:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},reactions:{description:"A list of reactions that is available to the monster to take during combat.",type:"array",items:{description:"Action available to a `Monster` in addition to the standard creature actions.",type:"object",properties:{name:{type:"string"},desc:{type:"string"},action_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},actions:{type:"array",items:{type:"object",properties:{action_name:{type:"string"},count:{type:"number"},type:{type:"string",enum:["melee","ranged","ability","magic"]}}}},options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},multiattack_type:{type:"string"},attack_bonus:{type:"number"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},attacks:{type:"array",items:{type:"object",properties:{name:{type:"string"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}},damage:{type:"array",items:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}},senses:{description:"Monsters typically have a passive perception but they might also have other senses to detect players.",type:"object",properties:{passive_perception:{description:"The monster's passive perception (wisdom) score.",type:"number"},blindsight:{description:"A monster with blindsight can perceive its surroundings without relying on sight, within a specific radius.",type:"string"},darkvision:{description:"A monster with darkvision can see in the dark within a specific radius.",type:"string"},tremorsense:{description:"A monster with tremorsense can detect and pinpoint the origin of vibrations within a specific radius, provided that the monster and the source of the vibrations are in contact with the same ground or substance.",type:"string"},truesight:{description:"A monster with truesight can, out to a specific range, see in normal and magical darkness, see invisible creatures and objects, automatically detect visual illusions and succeed on saving throws against them, and perceive the original form of a shapechanger or a creature that is transformed by magic. Furthermore, the monster can see into the Ethereal Plane within the same range.",type:"string"}}},special_abilities:{description:"A list of the monster's special abilities.",type:"array",items:{type:"object",properties:{name:{type:"string"},desc:{type:"string"},attack_bonus:{type:"number"},damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},spellcasting:{type:"object",properties:{ability:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc:{type:"number"},modifier:{type:"number"},components_required:{type:"array",items:{type:"string"}},school:{type:"string"},slots:{type:"object",additionalProperties:{type:"number"}},spells:{type:"array",items:{type:"object",properties:{name:{type:"string"},level:{type:"number"},url:{type:"string"},usage:{type:"object",properties:{type:{type:"string",enum:["at will","per day","recharge after rest","recharge on roll"]},rest_types:{type:"array",items:{type:"string"}},times:{type:"number"}}}}}}}},usage:{type:"object",properties:{type:{type:"string",enum:["at will","per day","recharge after rest","recharge on roll"]},rest_types:{type:"array",items:{type:"string"}},times:{type:"number"}}}}}},speed:{description:"Speed for a monster determines how fast it can move per turn.",type:"object",properties:{walk:{description:"All creatures have a walking speed, simply called the monster\u2019s speed. Creatures that have no form of ground-based locomotion have a walking speed of 0 feet.",type:"string"},burrow:{description:"A monster that has a burrowing speed can use that speed to move through sand, earth, mud, or ice. A monster can\u2019t burrow through solid rock unless it has a special trait that allows it to do so.",type:"string"},climb:{description:"A monster that has a climbing speed can use all or part of its movement to move on vertical surfaces. The monster doesn\u2019t need to spend extra movement to climb.",type:"string"},fly:{description:"A monster that has a flying speed can use all or part of its movement to fly.",type:"string"},swim:{description:"A monster that has a swimming speed doesn\u2019t need to spend extra movement to swim.",type:"string"}}},xp:{description:"The number of experience points (XP) a monster is worth is based on its challenge rating.",type:"number"}}},example:{index:"aboleth",name:"Aboleth",url:"/api/monsters/aboleth",actions:[{attacks:[],damage:[],desc:"The aboleth makes three tentacle attacks.",name:"Multiattack",multiattack_type:"actions",actions:[{action_name:"Tentacle",count:3,type:"melee"}]},{attack_bonus:9,attacks:[],damage:[{damage_dice:"2d6+5",damage_type:{index:"bludgeoning",name:"Bludgeoning",url:"/api/damage-types/bludgeoning"}},{damage_dice:"1d12",damage_type:{index:"acid",name:"Acid",url:"/api/damage-types/acid"}}],dc:{dc_type:{index:"con",name:"CON",url:"/api/ability-scores/con"},dc_value:14,success_type:"none"},desc:"Melee Weapon Attack: +9 to hit, reach 10 ft., one target. Hit: 12 (2d6 + 5) bludgeoning damage. If the target is a creature, it must succeed on a DC 14 Constitution saving throw or become diseased. The disease has no effect for 1 minute and can be removed by any magic that cures disease. After 1 minute, the diseased creature's skin becomes translucent and slimy, the creature can't regain hit points unless it is underwater, and the disease can be removed only by heal or another disease-curing spell of 6th level or higher. When the creature is outside a body of water, it takes 6 (1d12) acid damage every 10 minutes unless moisture is applied to the skin before 10 minutes have passed.",name:"Tentacle"},{attack_bonus:9,attacks:[],damage:[{damage_dice:"3d6+5",damage_type:{index:"bludgeoning",name:"Bludgeoning",url:"/api/damage-types/bludgeoning"}}],desc:"Melee Weapon Attack: +9 to hit, reach 10 ft. one target. Hit: 15 (3d6 + 5) bludgeoning damage.",name:"Tail"},{attacks:[],damage:[],dc:{dc_type:{index:"wis",name:"WIS",url:"/api/ability-scores/wis"},dc_value:14,success_type:"none"},desc:"The aboleth targets one creature it can see within 30 ft. of it. The target must succeed on a DC 14 Wisdom saving throw or be magically charmed by the aboleth until the aboleth dies or until it is on a different plane of existence from the target. The charmed target is under the aboleth's control and can't take reactions, and the aboleth and the target can communicate telepathically with each other over any distance.\nWhenever the charmed target takes damage, the target can repeat the saving throw. On a success, the effect ends. No more than once every 24 hours, the target can also repeat the saving throw when it is at least 1 mile away from the aboleth.",name:"Enslave",usage:{times:3,type:"per day"}}],alignment:"lawful evil",armor_class:[{type:"natural",value:17}],challenge_rating:10,charisma:18,condition_immunities:[],constitution:15,damage_immunities:[],damage_resistances:[],damage_vulnerabilities:[],dexterity:9,forms:[],hit_dice:"18d10",hit_points:135,hit_points_roll:"18d10+36",intelligence:18,languages:"Deep Speech, telepathy 120 ft.",legendary_actions:[{damage:[],desc:"The aboleth makes a Wisdom (Perception) check.",name:"Detect"},{damage:[],desc:"The aboleth makes one tail attack.",name:"Tail Swipe"},{attack_bonus:0,damage:[{damage_dice:"3d6",damage_type:{index:"psychic",name:"Psychic",url:"/api/damage-types/psychic"}}],desc:"One creature charmed by the aboleth takes 10 (3d6) psychic damage, and the aboleth regains hit points equal to the damage the creature takes.",name:"Psychic Drain (Costs 2 Actions)"}],proficiencies:[{proficiency:{index:"saving-throw-con",name:"Saving Throw: CON",url:"/api/proficiencies/saving-throw-con"},value:6},{proficiency:{index:"saving-throw-int",name:"Saving Throw: INT",url:"/api/proficiencies/saving-throw-int"},value:8},{proficiency:{index:"saving-throw-wis",name:"Saving Throw: WIS",url:"/api/proficiencies/saving-throw-wis"},value:6},{proficiency:{index:"skill-history",name:"Skill: History",url:"/api/proficiencies/skill-history"},value:12},{proficiency:{index:"skill-perception",name:"Skill: Perception",url:"/api/proficiencies/skill-perception"},value:10}],reactions:[],senses:{darkvision:"120 ft.",passive_perception:20},size:"Large",special_abilities:[{damage:[],desc:"The aboleth can breathe air and water.",name:"Amphibious"},{damage:[],dc:{dc_type:{index:"con",name:"CON",url:"/api/ability-scores/con"},dc_value:14,success_type:"none"},desc:"While underwater, the aboleth is surrounded by transformative mucus. A creature that touches the aboleth or that hits it with a melee attack while within 5 ft. of it must make a DC 14 Constitution saving throw. On a failure, the creature is diseased for 1d4 hours. The diseased creature can breathe only underwater.",name:"Mucous Cloud"},{damage:[],desc:"If a creature communicates telepathically with the aboleth, the aboleth learns the creature's greatest desires if the aboleth can see the creature.",name:"Probing Telepathy"}],speed:{swim:"40 ft.",walk:"10 ft."},strength:21,subtype:null,type:"aberration",wisdom:15,xp:5900}}}}},description:"Get monster by index.",method:"get",path:"/api/monsters/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get monster by index.",description:{type:"text/plain"},url:{path:["api","monsters",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the `Monster` to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-monster-by-index",previous:{title:"Get list of monsters with optional filtering",permalink:"/docs/api/get-list-of-monsters-with-optional-filtering"},next:{title:"Get a proficiency by index.",permalink:"/docs/api/get-a-proficiency-by-index"}},c=[];function a(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"get-monster-by-index",children:"Get monster by index."})}),"\n",(0,n.jsx)(i.p,{children:"Get monster by index."}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.code,{children:"index"})," of the ",(0,n.jsx)(i.code,{children:"Monster"})," to get."]})})]})})})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsx)("tbody",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(i.p,{children:"OK"})})]}),(0,n.jsx)("div",{children:(0,n.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Schema "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"charisma"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster's ability to charm or intimidate a player."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"constitution"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:'How sturdy a monster is."'})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dexterity"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The monster's ability for swift movement or stealth"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"intelligence"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The monster's ability to outsmart a player."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"strength"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"How hard a monster can hit a player."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"wisdom"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster's ability to ascertain the player's plan."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"image"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The image url of the monster."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"size"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"Tiny"}),", ",(0,n.jsx)(i.code,{children:"Small"}),", ",(0,n.jsx)(i.code,{children:"Medium"}),", ",(0,n.jsx)(i.code,{children:"Large"}),", ",(0,n.jsx)(i.code,{children:"Huge"}),", ",(0,n.jsx)(i.code,{children:"Gargantuan"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:'The size of the monster ranging from Tiny to Gargantuan."'})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The type of monster."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"subtype"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:'The sub-category of a monster used for classification of monsters."'})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"alignments"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"chaotic neutral"}),", ",(0,n.jsx)(i.code,{children:"chaotic evil"}),", ",(0,n.jsx)(i.code,{children:"chaotic good"}),", ",(0,n.jsx)(i.code,{children:"lawful neutral"}),", ",(0,n.jsx)(i.code,{children:"lawful evil"}),", ",(0,n.jsx)(i.code,{children:"lawful good"}),", ",(0,n.jsx)(i.code,{children:"neutral"}),", ",(0,n.jsx)(i.code,{children:"neutral evil"}),", ",(0,n.jsx)(i.code,{children:"neutral good"}),", ",(0,n.jsx)(i.code,{children:"any alignment"}),", ",(0,n.jsx)(i.code,{children:"unaligned"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A creature's general moral and personal attitudes."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"armor_class"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The difficulty for a player to successfully deal damage to a monster."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"hit_points"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The hit points of a monster determine how much damage it is able to take before it can be defeated."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"hit_dice"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The hit die of a monster can be used to make a version of the same monster whose hit points are determined by the roll of the die. For example: A monster with 2d6 would have its hit points determine by rolling a 6 sided die twice."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"hit_points_roll"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The roll for determining a monster's hit points, which consists of the hit dice (e.g. 18d10) and the modifier determined by its Constitution (e.g. +36). For example, 18d10+36"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"actions"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A list of actions that are available to the monster to take during combat."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"action_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"actions"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"action_name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"count"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"melee"}),", ",(0,n.jsx)(i.code,{children:"ranged"}),", ",(0,n.jsx)(i.code,{children:"ability"}),", ",(0,n.jsx)(i.code,{children:"magic"}),"]"]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"multiattack_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"attack_bonus"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"DC"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_value"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Value to beat"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"success_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"attacks"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"DC"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_value"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Value to beat"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"success_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Damage"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_dice"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_dice"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"legendary_actions"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A list of legendary actions that are available to the monster to take during combat."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"action_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"actions"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"action_name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"count"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"melee"}),", ",(0,n.jsx)(i.code,{children:"ranged"}),", ",(0,n.jsx)(i.code,{children:"ability"}),", ",(0,n.jsx)(i.code,{children:"magic"}),"]"]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"multiattack_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"attack_bonus"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"DC"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_value"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Value to beat"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"success_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"attacks"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"DC"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_value"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Value to beat"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"success_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Damage"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_dice"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_dice"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"challenge_rating"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," value \u2264 21"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster's challenge rating is a guideline number that says when a monster becomes an appropriate challenge against the party's average level. For example. A group of 4 players with an average level of 4 would have an appropriate combat challenge against a monster with a challenge rating of 4 but a monster with a challenge rating of 8 against the same group of players would pose a significant threat."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"condition_immunities"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A list of conditions that a monster is immune to."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_immunities"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A list of damage types that a monster will take double damage from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_resistances"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A list of damage types that a monster will take half damage from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_vulnerabilities"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A list of damage types that a monster will take double damage from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"forms"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"List of other related monster entries that are of the same form. Only applicable to Lycanthropes that have multiple forms."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"languages"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The languages a monster is able to speak."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"proficiencies"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A list of proficiencies of a monster."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"value"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"proficiency"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"reactions"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A list of reactions that is available to the monster to take during combat."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"action_options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"actions"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"action_name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"count"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"melee"}),", ",(0,n.jsx)(i.code,{children:"ranged"}),", ",(0,n.jsx)(i.code,{children:"ability"}),", ",(0,n.jsx)(i.code,{children:"magic"}),"]"]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"options"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Choice"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choose"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"from"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"multiattack_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"attack_bonus"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"DC"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_value"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Value to beat"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"success_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"attacks"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"DC"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_value"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Value to beat"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"success_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Damage"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_dice"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_dice"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"senses"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Monsters typically have a passive perception but they might also have other senses to detect players."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"passive_perception"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The monster's passive perception (wisdom) score."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"blindsight"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster with blindsight can perceive its surroundings without relying on sight, within a specific radius."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"darkvision"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster with darkvision can see in the dark within a specific radius."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"tremorsense"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster with tremorsense can detect and pinpoint the origin of vibrations within a specific radius, provided that the monster and the source of the vibrations are in contact with the same ground or substance."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"truesight"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster with truesight can, out to a specific range, see in normal and magical darkness, see invisible creatures and objects, automatically detect visual illusions and succeed on saving throws against them, and perceive the original form of a shapechanger or a creature that is transformed by magic. Furthermore, the monster can see into the Ethereal Plane within the same range."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"special_abilities"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A list of the monster's special abilities."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"desc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"attack_bonus"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"Damage"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_dice"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"damage_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"DC"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc_value"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Value to beat"})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"success_type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spellcasting"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"ability"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"APIReference"})})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Level of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"dc"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"modifier"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"components_required"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"school"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"slots"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"spells"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"name"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"level"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"url"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"usage"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"at will"}),", ",(0,n.jsx)(i.code,{children:"per day"}),", ",(0,n.jsx)(i.code,{children:"recharge after rest"}),", ",(0,n.jsx)(i.code,{children:"recharge on roll"}),"]"]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"rest_types"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"times"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"usage"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Possible values:"})," [",(0,n.jsx)(i.code,{children:"at will"}),", ",(0,n.jsx)(i.code,{children:"per day"}),", ",(0,n.jsx)(i.code,{children:"recharge after rest"}),", ",(0,n.jsx)(i.code,{children:"recharge on roll"}),"]"]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"rest_types"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"times"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"speed"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"Speed for a monster determines how fast it can move per turn."})}),(0,n.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"walk"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"All creatures have a walking speed, simply called the monster\u2019s speed. Creatures that have no form of ground-based locomotion have a walking speed of 0 feet."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"burrow"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster that has a burrowing speed can use that speed to move through sand, earth, mud, or ice. A monster can\u2019t burrow through solid rock unless it has a special trait that allows it to do so."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"climb"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster that has a climbing speed can use all or part of its movement to move on vertical surfaces. The monster doesn\u2019t need to spend extra movement to climb."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"fly"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster that has a flying speed can use all or part of its movement to fly."})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"swim"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"A monster that has a swimming speed doesn\u2019t need to spend extra movement to swim."})})]})})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"xp"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(i.p,{children:"The number of experience points (XP) a monster is worth is based on its challenge rating."})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,i,s)=>{s.d(i,{R:()=>o,x:()=>l});var n=s(96540);const t={},r=n.createContext(t);function o(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f8b89776.ffd69768.js b/assets/js/f8b89776.ffd69768.js new file mode 100644 index 0000000..4e3955d --- /dev/null +++ b/assets/js/f8b89776.ffd69768.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3576],{76438:(e,i,s)=>{s.r(i),s.d(i,{contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var t=s(74848),n=s(28453);const r={},o="Get monster by index.",l={type:"api",id:"get-monster-by-index",title:"Get monster by index.",description:"",slug:"/get-monster-by-index",frontMatter:{},api:{tags:["Monsters"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the `Monster` to get.\n",schema:{type:"string",example:"aboleth"}}],responses:{200:{description:"OK",content:{"application/json":{schema:{description:"`Monster`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"},desc:{description:"Description of the resource.",type:"array",items:{type:"string"}},charisma:{description:"A monster's ability to charm or intimidate a player.",type:"number"},constitution:{description:'How sturdy a monster is."',type:"number"},dexterity:{description:"The monster's ability for swift movement or stealth",type:"number"},intelligence:{description:"The monster's ability to outsmart a player.",type:"number"},strength:{description:"How hard a monster can hit a player.",type:"number"},wisdom:{description:"A monster's ability to ascertain the player's plan.",type:"number"},image:{description:"The image url of the monster.",type:"string"},size:{description:'The size of the monster ranging from Tiny to Gargantuan."',type:"string",enum:["Tiny","Small","Medium","Large","Huge","Gargantuan"]},type:{description:"The type of monster.",type:"string"},subtype:{description:'The sub-category of a monster used for classification of monsters."',type:"string"},alignment:{description:"A creature's general moral and personal attitudes.",type:"string"},armor_class:{description:"The difficulty for a player to successfully deal damage to a monster.",type:"array",items:{description:"The armor class of a monster.",type:"object",oneOf:[{type:"object",properties:{type:{type:"string",enum:["dex"]},value:{type:"number"},desc:{type:"string"}}},{type:"object",properties:{type:{type:"string",enum:["natural"]},value:{type:"number"},desc:{type:"string"}}},{type:"object",properties:{type:{type:"string",enum:["armor"]},value:{type:"number"},armor:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},desc:{type:"string"}}},{type:"object",properties:{type:{type:"string",enum:["spell"]},value:{type:"number"},spell:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},desc:{type:"string"}}},{type:"object",properties:{type:{type:"string",enum:["condition"]},value:{type:"number"},condition:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},desc:{type:"string"}}}]}},hit_points:{description:"The hit points of a monster determine how much damage it is able to take before it can be defeated.",type:"number"},hit_dice:{description:"The hit die of a monster can be used to make a version of the same monster whose hit points are determined by the roll of the die. For example: A monster with 2d6 would have its hit points determine by rolling a 6 sided die twice.",type:"string"},hit_points_roll:{description:"The roll for determining a monster's hit points, which consists of the hit dice (e.g. 18d10) and the modifier determined by its Constitution (e.g. +36). For example, 18d10+36",type:"string"},actions:{description:"A list of actions that are available to the monster to take during combat.",type:"array",items:{description:"Action available to a `Monster` in addition to the standard creature actions.",type:"object",properties:{name:{type:"string"},desc:{type:"string"},action_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},actions:{type:"array",items:{type:"object",properties:{action_name:{type:"string"},count:{type:"number"},type:{type:"string",enum:["melee","ranged","ability","magic"]}}}},options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},multiattack_type:{type:"string"},attack_bonus:{type:"number"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},attacks:{type:"array",items:{type:"object",properties:{name:{type:"string"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}},damage:{type:"array",items:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}},legendary_actions:{description:"A list of legendary actions that are available to the monster to take during combat.",type:"array",items:{description:"Action available to a `Monster` in addition to the standard creature actions.",type:"object",properties:{name:{type:"string"},desc:{type:"string"},action_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},actions:{type:"array",items:{type:"object",properties:{action_name:{type:"string"},count:{type:"number"},type:{type:"string",enum:["melee","ranged","ability","magic"]}}}},options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},multiattack_type:{type:"string"},attack_bonus:{type:"number"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},attacks:{type:"array",items:{type:"object",properties:{name:{type:"string"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}},damage:{type:"array",items:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}},challenge_rating:{description:"A monster's challenge rating is a guideline number that says when a monster becomes an appropriate challenge against the party's average level. For example. A group of 4 players with an average level of 4 would have an appropriate combat challenge against a monster with a challenge rating of 4 but a monster with a challenge rating of 8 against the same group of players would pose a significant threat.",type:"number",minimum:0,maximum:21},proficiency_bonus:{description:"A monster's proficiency bonus is the number added to ability checks, saving throws and attack rolls in which the monster is proficient, and is linked to the monster's challenge rating. This bonus has already been included in the monster's stats where applicable.",type:"number",minimum:2,maximum:9},condition_immunities:{description:"A list of conditions that a monster is immune to.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},damage_immunities:{description:"A list of damage types that a monster will take double damage from.",type:"array",items:{type:"string"}},damage_resistances:{description:"A list of damage types that a monster will take half damage from.",type:"array",items:{type:"string"}},damage_vulnerabilities:{description:"A list of damage types that a monster will take double damage from.",type:"array",items:{type:"string"}},forms:{description:"List of other related monster entries that are of the same form. Only applicable to Lycanthropes that have multiple forms.",type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}},languages:{description:"The languages a monster is able to speak.",type:"string"},proficiencies:{description:"A list of proficiencies of a monster.",type:"array",items:{type:"object",properties:{value:{type:"number"},proficiency:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}},reactions:{description:"A list of reactions that is available to the monster to take during combat.",type:"array",items:{description:"Action available to a `Monster` in addition to the standard creature actions.",type:"object",properties:{name:{type:"string"},desc:{type:"string"},action_options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},actions:{type:"array",items:{type:"object",properties:{action_name:{type:"string"},count:{type:"number"},type:{type:"string",enum:["melee","ranged","ability","magic"]}}}},options:{description:"`Choice`\n",type:"object",properties:{desc:{description:"Description of the choice to be made.",type:"string"},choose:{description:"Number of items to pick from the list.",type:"number"},type:{description:"Type of the resources to choose from.",type:"string"},from:{$ref:"#/components/schemas/OptionSet"}}},multiattack_type:{type:"string"},attack_bonus:{type:"number"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},attacks:{type:"array",items:{type:"object",properties:{name:{type:"string"},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}},damage:{type:"array",items:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}},senses:{description:"Monsters typically have a passive perception but they might also have other senses to detect players.",type:"object",properties:{passive_perception:{description:"The monster's passive perception (wisdom) score.",type:"number"},blindsight:{description:"A monster with blindsight can perceive its surroundings without relying on sight, within a specific radius.",type:"string"},darkvision:{description:"A monster with darkvision can see in the dark within a specific radius.",type:"string"},tremorsense:{description:"A monster with tremorsense can detect and pinpoint the origin of vibrations within a specific radius, provided that the monster and the source of the vibrations are in contact with the same ground or substance.",type:"string"},truesight:{description:"A monster with truesight can, out to a specific range, see in normal and magical darkness, see invisible creatures and objects, automatically detect visual illusions and succeed on saving throws against them, and perceive the original form of a shapechanger or a creature that is transformed by magic. Furthermore, the monster can see into the Ethereal Plane within the same range.",type:"string"}}},special_abilities:{description:"A list of the monster's special abilities.",type:"array",items:{type:"object",properties:{name:{type:"string"},desc:{type:"string"},attack_bonus:{type:"number"},damage:{description:"`Damage`\n",type:"object",properties:{damage_dice:{type:"string"},damage_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}},dc:{description:"`DC`\n",type:"object",properties:{dc_type:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc_value:{description:"Value to beat",type:"number"},success_type:{description:'Result of a successful save. Can be \\"none\\", \\"half\\", or \\"other\\"',type:"string"}}},spellcasting:{type:"object",properties:{ability:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}},dc:{type:"number"},modifier:{type:"number"},components_required:{type:"array",items:{type:"string"}},school:{type:"string"},slots:{type:"object",additionalProperties:{type:"number"}},spells:{type:"array",items:{type:"object",properties:{name:{type:"string"},level:{type:"number"},url:{type:"string"},usage:{type:"object",properties:{type:{type:"string",enum:["at will","per day","recharge after rest","recharge on roll"]},rest_types:{type:"array",items:{type:"string"}},times:{type:"number"}}}}}}}},usage:{type:"object",properties:{type:{type:"string",enum:["at will","per day","recharge after rest","recharge on roll"]},rest_types:{type:"array",items:{type:"string"}},times:{type:"number"}}}}}},speed:{description:"Speed for a monster determines how fast it can move per turn.",type:"object",properties:{walk:{description:"All creatures have a walking speed, simply called the monster\u2019s speed. Creatures that have no form of ground-based locomotion have a walking speed of 0 feet.",type:"string"},burrow:{description:"A monster that has a burrowing speed can use that speed to move through sand, earth, mud, or ice. A monster can\u2019t burrow through solid rock unless it has a special trait that allows it to do so.",type:"string"},climb:{description:"A monster that has a climbing speed can use all or part of its movement to move on vertical surfaces. The monster doesn\u2019t need to spend extra movement to climb.",type:"string"},fly:{description:"A monster that has a flying speed can use all or part of its movement to fly.",type:"string"},swim:{description:"A monster that has a swimming speed doesn\u2019t need to spend extra movement to swim.",type:"string"}}},xp:{description:"The number of experience points (XP) a monster is worth is based on its challenge rating.",type:"number"}}},example:{index:"aboleth",name:"Aboleth",url:"/api/monsters/aboleth",actions:[{attacks:[],damage:[],desc:"The aboleth makes three tentacle attacks.",name:"Multiattack",multiattack_type:"actions",actions:[{action_name:"Tentacle",count:3,type:"melee"}]},{attack_bonus:9,attacks:[],damage:[{damage_dice:"2d6+5",damage_type:{index:"bludgeoning",name:"Bludgeoning",url:"/api/damage-types/bludgeoning"}},{damage_dice:"1d12",damage_type:{index:"acid",name:"Acid",url:"/api/damage-types/acid"}}],dc:{dc_type:{index:"con",name:"CON",url:"/api/ability-scores/con"},dc_value:14,success_type:"none"},desc:"Melee Weapon Attack: +9 to hit, reach 10 ft., one target. Hit: 12 (2d6 + 5) bludgeoning damage. If the target is a creature, it must succeed on a DC 14 Constitution saving throw or become diseased. The disease has no effect for 1 minute and can be removed by any magic that cures disease. After 1 minute, the diseased creature's skin becomes translucent and slimy, the creature can't regain hit points unless it is underwater, and the disease can be removed only by heal or another disease-curing spell of 6th level or higher. When the creature is outside a body of water, it takes 6 (1d12) acid damage every 10 minutes unless moisture is applied to the skin before 10 minutes have passed.",name:"Tentacle"},{attack_bonus:9,attacks:[],damage:[{damage_dice:"3d6+5",damage_type:{index:"bludgeoning",name:"Bludgeoning",url:"/api/damage-types/bludgeoning"}}],desc:"Melee Weapon Attack: +9 to hit, reach 10 ft. one target. Hit: 15 (3d6 + 5) bludgeoning damage.",name:"Tail"},{attacks:[],damage:[],dc:{dc_type:{index:"wis",name:"WIS",url:"/api/ability-scores/wis"},dc_value:14,success_type:"none"},desc:"The aboleth targets one creature it can see within 30 ft. of it. The target must succeed on a DC 14 Wisdom saving throw or be magically charmed by the aboleth until the aboleth dies or until it is on a different plane of existence from the target. The charmed target is under the aboleth's control and can't take reactions, and the aboleth and the target can communicate telepathically with each other over any distance.\nWhenever the charmed target takes damage, the target can repeat the saving throw. On a success, the effect ends. No more than once every 24 hours, the target can also repeat the saving throw when it is at least 1 mile away from the aboleth.",name:"Enslave",usage:{times:3,type:"per day"}}],alignment:"lawful evil",armor_class:[{type:"natural",value:17}],challenge_rating:10,proficiency_bonus:4,charisma:18,condition_immunities:[],constitution:15,damage_immunities:[],damage_resistances:[],damage_vulnerabilities:[],dexterity:9,forms:[],hit_dice:"18d10",hit_points:135,hit_points_roll:"18d10+36",intelligence:18,languages:"Deep Speech, telepathy 120 ft.",legendary_actions:[{damage:[],desc:"The aboleth makes a Wisdom (Perception) check.",name:"Detect"},{damage:[],desc:"The aboleth makes one tail attack.",name:"Tail Swipe"},{attack_bonus:0,damage:[{damage_dice:"3d6",damage_type:{index:"psychic",name:"Psychic",url:"/api/damage-types/psychic"}}],desc:"One creature charmed by the aboleth takes 10 (3d6) psychic damage, and the aboleth regains hit points equal to the damage the creature takes.",name:"Psychic Drain (Costs 2 Actions)"}],proficiencies:[{proficiency:{index:"saving-throw-con",name:"Saving Throw: CON",url:"/api/proficiencies/saving-throw-con"},value:6},{proficiency:{index:"saving-throw-int",name:"Saving Throw: INT",url:"/api/proficiencies/saving-throw-int"},value:8},{proficiency:{index:"saving-throw-wis",name:"Saving Throw: WIS",url:"/api/proficiencies/saving-throw-wis"},value:6},{proficiency:{index:"skill-history",name:"Skill: History",url:"/api/proficiencies/skill-history"},value:12},{proficiency:{index:"skill-perception",name:"Skill: Perception",url:"/api/proficiencies/skill-perception"},value:10}],reactions:[],senses:{darkvision:"120 ft.",passive_perception:20},size:"Large",special_abilities:[{damage:[],desc:"The aboleth can breathe air and water.",name:"Amphibious"},{damage:[],dc:{dc_type:{index:"con",name:"CON",url:"/api/ability-scores/con"},dc_value:14,success_type:"none"},desc:"While underwater, the aboleth is surrounded by transformative mucus. A creature that touches the aboleth or that hits it with a melee attack while within 5 ft. of it must make a DC 14 Constitution saving throw. On a failure, the creature is diseased for 1d4 hours. The diseased creature can breathe only underwater.",name:"Mucous Cloud"},{damage:[],desc:"If a creature communicates telepathically with the aboleth, the aboleth learns the creature's greatest desires if the aboleth can see the creature.",name:"Probing Telepathy"}],speed:{swim:"40 ft.",walk:"10 ft."},strength:21,subtype:null,type:"aberration",wisdom:15,xp:5900}}}}},description:"Get monster by index.",method:"get",path:"/api/monsters/{index}",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get monster by index.",description:{type:"text/plain"},url:{path:["api","monsters",":index"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the `Monster` to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-monster-by-index",previous:{title:"Get list of monsters with optional filtering",permalink:"/docs/api/get-list-of-monsters-with-optional-filtering"},next:{title:"Get a proficiency by index.",permalink:"/docs/api/get-a-proficiency-by-index"}},c=[];function a(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"get-monster-by-index",children:"Get monster by index."})}),"\n",(0,t.jsx)(i.p,{children:"Get monster by index."}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:["The ",(0,t.jsx)(i.code,{children:"index"})," of the ",(0,t.jsx)(i.code,{children:"Monster"})," to get."]})})]})})})]}),"\n",(0,t.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,t.jsx)("tbody",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsxs)("div",{style:{display:"flex"},children:[(0,t.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)("code",{children:"200"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.p,{children:"OK"})})]}),(0,t.jsx)("div",{children:(0,t.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,t.jsx)("thead",{children:(0,t.jsx)("tr",{children:(0,t.jsxs)("th",{style:{textAlign:"left"},children:[(0,t.jsx)("span",{children:"Schema "}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{})]})})}),(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"charisma"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster's ability to charm or intimidate a player."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"constitution"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:'How sturdy a monster is."'})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dexterity"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The monster's ability for swift movement or stealth"})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"intelligence"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The monster's ability to outsmart a player."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"strength"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"How hard a monster can hit a player."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"wisdom"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster's ability to ascertain the player's plan."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"image"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The image url of the monster."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"size"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"Tiny"}),", ",(0,t.jsx)(i.code,{children:"Small"}),", ",(0,t.jsx)(i.code,{children:"Medium"}),", ",(0,t.jsx)(i.code,{children:"Large"}),", ",(0,t.jsx)(i.code,{children:"Huge"}),", ",(0,t.jsx)(i.code,{children:"Gargantuan"}),"]"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:'The size of the monster ranging from Tiny to Gargantuan."'})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The type of monster."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"subtype"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:'The sub-category of a monster used for classification of monsters."'})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"alignment"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A creature's general moral and personal attitudes."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"armor_class"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The difficulty for a player to successfully deal damage to a monster."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"hit_points"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The hit points of a monster determine how much damage it is able to take before it can be defeated."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"hit_dice"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The hit die of a monster can be used to make a version of the same monster whose hit points are determined by the roll of the die. For example: A monster with 2d6 would have its hit points determine by rolling a 6 sided die twice."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"hit_points_roll"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The roll for determining a monster's hit points, which consists of the hit dice (e.g. 18d10) and the modifier determined by its Constitution (e.g. +36). For example, 18d10+36"})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"actions"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of actions that are available to the monster to take during combat."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"action_options"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Choice"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"choose"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"from"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"actions"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"action_name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"count"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"melee"}),", ",(0,t.jsx)(i.code,{children:"ranged"}),", ",(0,t.jsx)(i.code,{children:"ability"}),", ",(0,t.jsx)(i.code,{children:"magic"}),"]"]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"options"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Choice"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"choose"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"from"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"multiattack_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"attack_bonus"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"DC"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_value"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Value to beat"})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"success_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"attacks"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"DC"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_value"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Value to beat"})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"success_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Damage"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_dice"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_dice"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"legendary_actions"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of legendary actions that are available to the monster to take during combat."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"action_options"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Choice"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"choose"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"from"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"actions"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"action_name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"count"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"melee"}),", ",(0,t.jsx)(i.code,{children:"ranged"}),", ",(0,t.jsx)(i.code,{children:"ability"}),", ",(0,t.jsx)(i.code,{children:"magic"}),"]"]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"options"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Choice"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"choose"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"from"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"multiattack_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"attack_bonus"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"DC"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_value"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Value to beat"})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"success_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"attacks"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"DC"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_value"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Value to beat"})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"success_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Damage"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_dice"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_dice"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"challenge_rating"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," value \u2264 21"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster's challenge rating is a guideline number that says when a monster becomes an appropriate challenge against the party's average level. For example. A group of 4 players with an average level of 4 would have an appropriate combat challenge against a monster with a challenge rating of 4 but a monster with a challenge rating of 8 against the same group of players would pose a significant threat."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"proficiency_bonus"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," 2 \u2264 value \u2264 9"]})}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster's proficiency bonus is the number added to ability checks, saving throws and attack rolls in which the monster is proficient, and is linked to the monster's challenge rating. This bonus has already been included in the monster's stats where applicable."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"condition_immunities"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of conditions that a monster is immune to."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_immunities"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of damage types that a monster will take double damage from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_resistances"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of damage types that a monster will take half damage from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_vulnerabilities"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of damage types that a monster will take double damage from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"forms"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"List of other related monster entries that are of the same form. Only applicable to Lycanthropes that have multiple forms."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"languages"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The languages a monster is able to speak."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"proficiencies"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of proficiencies of a monster."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"value"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"proficiency"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"reactions"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of reactions that is available to the monster to take during combat."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"action_options"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Choice"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"choose"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"from"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"actions"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"action_name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"count"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"melee"}),", ",(0,t.jsx)(i.code,{children:"ranged"}),", ",(0,t.jsx)(i.code,{children:"ability"}),", ",(0,t.jsx)(i.code,{children:"magic"}),"]"]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"options"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Choice"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Description of the choice to be made."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"choose"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Number of items to pick from the list."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Type of the resources to choose from."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"from"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" (circular)"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"multiattack_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"attack_bonus"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"DC"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_value"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Value to beat"})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"success_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"attacks"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"DC"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_value"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Value to beat"})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"success_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Damage"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_dice"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_dice"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"senses"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Monsters typically have a passive perception but they might also have other senses to detect players."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"passive_perception"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The monster's passive perception (wisdom) score."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"blindsight"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster with blindsight can perceive its surroundings without relying on sight, within a specific radius."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"darkvision"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster with darkvision can see in the dark within a specific radius."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"tremorsense"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster with tremorsense can detect and pinpoint the origin of vibrations within a specific radius, provided that the monster and the source of the vibrations are in contact with the same ground or substance."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"truesight"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster with truesight can, out to a specific range, see in normal and magical darkness, see invisible creatures and objects, automatically detect visual illusions and succeed on saving throws against them, and perceive the original form of a shapechanger or a creature that is transformed by magic. Furthermore, the monster can see into the Ethereal Plane within the same range."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"special_abilities"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A list of the monster's special abilities."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"desc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"attack_bonus"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"Damage"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_dice"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"damage_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"DC"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc_value"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Value to beat"})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"success_type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:'Result of a successful save. Can be "none", "half", or "other"'})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"spellcasting"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"ability"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"APIReference"})})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"index"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Resource index for shorthand searching."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Name of the referenced resource."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"URL of the referenced resource."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"dc"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"modifier"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"components_required"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"school"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"slots"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"spells"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"name"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"level"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"url"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"usage"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"at will"}),", ",(0,t.jsx)(i.code,{children:"per day"}),", ",(0,t.jsx)(i.code,{children:"recharge after rest"}),", ",(0,t.jsx)(i.code,{children:"recharge on roll"}),"]"]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"rest_types"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"times"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})})]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"usage"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"type"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.strong,{children:"Possible values:"})," [",(0,t.jsx)(i.code,{children:"at will"}),", ",(0,t.jsx)(i.code,{children:"per day"}),", ",(0,t.jsx)(i.code,{children:"recharge after rest"}),", ",(0,t.jsx)(i.code,{children:"recharge on roll"}),"]"]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"rest_types"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"times"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"})]})})]})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"speed"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" object"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"Speed for a monster determines how fast it can move per turn."})}),(0,t.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"walk"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"All creatures have a walking speed, simply called the monster\u2019s speed. Creatures that have no form of ground-based locomotion have a walking speed of 0 feet."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"burrow"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster that has a burrowing speed can use that speed to move through sand, earth, mud, or ice. A monster can\u2019t burrow through solid rock unless it has a special trait that allows it to do so."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"climb"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster that has a climbing speed can use all or part of its movement to move on vertical surfaces. The monster doesn\u2019t need to spend extra movement to climb."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"fly"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster that has a flying speed can use all or part of its movement to fly."})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"swim"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"A monster that has a swimming speed doesn\u2019t need to spend extra movement to swim."})})]})})]})})]})}),(0,t.jsx)("tr",{children:(0,t.jsxs)("td",{children:[(0,t.jsx)("code",{children:"xp"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,t.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,t.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,t.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,t.jsx)(i.p,{children:"The number of experience points (XP) a monster is worth is based on its challenge rating."})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:i}={...(0,n.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},28453:(e,i,s)=>{s.d(i,{R:()=>o,x:()=>l});var t=s(96540);const n={},r=t.createContext(n);function o(e){const i=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),t.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fd5d3f69.ad859703.js b/assets/js/fd5d3f69.ad859703.js new file mode 100644 index 0000000..87882c4 --- /dev/null +++ b/assets/js/fd5d3f69.ad859703.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[382],{67524:(e,t,i)=>{i.r(t),i.d(t,{contentTitle:()=>a,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>o});var r=i(74848),s=i(28453);const n={},a="Get traits available for a subrace.",l={type:"api",id:"get-traits-available-for-a-subrace",title:"Get traits available for a subrace.",description:"",slug:"/get-traits-available-for-a-subrace",frontMatter:{},api:{tags:["Subraces"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subrace to get.\n",schema:{type:"string",enum:["high-elf","hill-dwarf","lightfoot-halfling","rock-gnome"],example:"hill-dwarf"}}],responses:{200:{description:"List of traits for the subrace.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get traits available for a subrace.",method:"get",path:"/api/subraces/{index}/traits",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get traits available for a subrace.",description:{type:"text/plain"},url:{path:["api","subraces",":index","traits"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subrace to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-traits-available-for-a-subrace",previous:{title:"Get proficiences available for a subrace.",permalink:"/docs/api/get-proficiences-available-for-a-subrace"},next:{title:"Get a trait by index.",permalink:"/docs/api/get-a-trait-by-index"}},o=[];function c(e){const t={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"get-traits-available-for-a-subrace",children:"Get traits available for a subrace."})}),"\n",(0,r.jsx)(t.p,{children:"Get traits available for a subrace."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Possible values:"})," [",(0,r.jsx)(t.code,{children:"high-elf"}),", ",(0,r.jsx)(t.code,{children:"hill-dwarf"}),", ",(0,r.jsx)(t.code,{children:"lightfoot-halfling"}),", ",(0,r.jsx)(t.code,{children:"rock-gnome"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(t.p,{children:["The ",(0,r.jsx)(t.code,{children:"index"})," of the subrace to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(t.p,{children:"List of traits for the subrace."})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},28453:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>l});var r=i(96540);const s={},n=r.createContext(s);function a(e){const t=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fd5d3f69.caf40515.js b/assets/js/fd5d3f69.caf40515.js deleted file mode 100644 index 688f4a2..0000000 --- a/assets/js/fd5d3f69.caf40515.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[382],{67524:(e,t,i)=>{i.r(t),i.d(t,{contentTitle:()=>a,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>o});var r=i(74848),s=i(28453);const n={},a="Get traits available for a subrace.",l={type:"api",id:"get-traits-available-for-a-subrace",title:"Get traits available for a subrace.",description:"",slug:"/get-traits-available-for-a-subrace",frontMatter:{},api:{tags:["Subraces"],parameters:[{name:"index",in:"path",required:!0,description:"The `index` of the subrace to get.\n",schema:{type:"string",enum:["high-elf","hill-dwarf","lightfoot-halfling","rock-gnome"],example:"hill-dwarf"}}],responses:{200:{description:"List of traits for the subrace.",content:{"application/json":{schema:{description:"`APIReferenceList`\n",type:"object",properties:{count:{description:"Total number of resources available.",type:"number"},results:{type:"array",items:{description:"`APIReference`\n",type:"object",properties:{index:{description:"Resource index for shorthand searching.",type:"string"},level:{description:"Level of the referenced resource.",type:"integer"},name:{description:"Name of the referenced resource.",type:"string"},url:{description:"URL of the referenced resource.",type:"string"}}}}}}}}}},description:"Get traits available for a subrace.",method:"get",path:"/api/subraces/{index}/traits",servers:[{url:"https://www.dnd5eapi.co",description:"Production"},{url:"http://localhost:3000",description:"Local Development"}],info:{title:"D&D 5e API",description:"",version:"0.1",license:{name:"MIT License",url:"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},contact:{name:"5eBits",url:"https://github.com/5e-bits"}},postman:{name:"Get traits available for a subrace.",description:{type:"text/plain"},url:{path:["api","subraces",":index","traits"],host:["{{baseUrl}}"],query:[],variable:[{description:{content:"(Required) The `index` of the subrace to get.\n",type:"text/plain"},type:"any",value:"",key:"index"}]},method:"GET"}},source:"@site/openapi.json",sourceDirName:".",permalink:"/docs/api/get-traits-available-for-a-subrace",previous:{title:"Get proficiences available for a subrace.",permalink:"/docs/api/get-proficiences-available-for-a-subrace"},next:{title:"Get a trait by index.",permalink:"/docs/api/get-a-trait-by-index"}},o=[];function c(e){const t={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"get-traits-available-for-a-subrace",children:"Get traits available for a subrace."})}),"\n",(0,r.jsx)(t.p,{children:"Get traits available for a subrace."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Possible values:"})," [",(0,r.jsx)(t.code,{children:"high-elf"}),", ",(0,r.jsx)(t.code,{children:"hill-dwarf"}),", ",(0,r.jsx)(t.code,{children:"lightfoot-halfling"}),", ",(0,r.jsx)(t.code,{children:"rock-gnome"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(t.p,{children:["The ",(0,r.jsx)(t.code,{children:"index"})," of the subrace to get."]})})]})})})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,r.jsx)("tbody",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsxs)("div",{style:{display:"flex"},children:[(0,r.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)("code",{children:"200"})}),(0,r.jsx)("div",{children:(0,r.jsx)(t.p,{children:"List of traits for the subrace."})})]}),(0,r.jsx)("div",{children:(0,r.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsxs)("th",{style:{textAlign:"left"},children:[(0,r.jsx)("span",{children:"Schema "}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{})]})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"count"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" number"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"Total number of resources available."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"results"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"index"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"Resource index for shorthand searching."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"level"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" integer"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"Level of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"name"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"Name of the referenced resource."})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"url"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(t.p,{children:"URL of the referenced resource."})})]})})]})})]})})]})]})})]})})})]})]})}function d(e){void 0===e&&(e={});const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},28453:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>l});var r=i(96540);const s={},n=r.createContext(s);function a(e){const t=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.9d4f036d.js b/assets/js/runtime~main.70bb79af.js similarity index 53% rename from assets/js/runtime~main.9d4f036d.js rename to assets/js/runtime~main.70bb79af.js index a16986f..d42086d 100644 --- a/assets/js/runtime~main.9d4f036d.js +++ b/assets/js/runtime~main.70bb79af.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,d,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,r),c.loaded=!0,c.exports}r.m=b,e=[],r.O=(a,c,f,d)=>{if(!c){var b=1/0;for(i=0;i=d)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,d0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[c,f,d]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);r.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(d,b),d},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"a65f7afd",382:"fd5d3f69",545:"e73018c5",598:"cd17f53f",613:"c57c8e3d",636:"1334a6b9",940:"944a6f01",1049:"4e0d1431",1169:"8e53799d",1235:"a7456010",1297:"2d6b3abf",1358:"852ad0b5",1378:"4998527c",1488:"ac3cc3f5",1621:"9a539b0e",1625:"92852ade",1635:"daa8ef3b",1899:"5043549d",1932:"ddff8a46",2138:"1a4e3797",2178:"4def2e36",2256:"11b43341",2309:"98ff8580",2484:"bdef5384",2589:"d1a9398a",2597:"c5b3f5ce",2627:"71c3de18",2917:"2be17892",3027:"ea4c02b1",3105:"001c3fda",3138:"61cee229",3162:"20bf0014",3190:"8f6ee0c6",3347:"b5257597",3359:"a8dfb490",3437:"8e1b9ec5",3576:"f8b89776",3633:"792c8e11",4006:"35c21b4c",4243:"ae15d4dd",4574:"1e3dcad6",4583:"1df93b7f",4819:"df53a957",4921:"138e0e15",4951:"4d9dc338",5359:"90e0e748",5437:"077a73ed",5503:"e6ba45fe",5742:"aba21aa0",5799:"7c524999",5850:"9c8fcee4",5884:"b2a6176d",5899:"a09c2993",5900:"99171cef",6231:"cc2a131f",6473:"4c5e977b",6619:"3d50c95e",6979:"c60b12b2",7098:"a7bd4aaa",7243:"46aa36fa",8070:"0480b142",8101:"91ee6e85",8317:"7c914a69",8401:"17896441",8926:"c2c0fda6",9048:"a94703ab",9117:"75a4143c",9180:"20aea505",9536:"0d2c3858",9647:"5e95c892",9840:"85848f1c",9947:"344736af",9951:"10aca893"}[e]||e)+"."+{53:"9b96f3a2",141:"11efc51f",382:"caf40515",489:"79124cfe",495:"67860476",545:"19afc6d0",598:"5d209dd4",604:"e9498d4b",613:"91f549b8",636:"a5088088",940:"cd8ad998",971:"d6c5a2f3",1049:"c3d19b98",1169:"01fed9f1",1176:"ff3ff93c",1235:"db4ccd1a",1297:"e384b6f4",1329:"7168e9f9",1358:"e729e815",1378:"9f8a2148",1488:"f5f8e859",1621:"705d3c76",1625:"7cdc287f",1635:"41198f39",1689:"81a43fd6",1899:"1a676e99",1932:"da87a8d7",1987:"3dafef79",2130:"4a68cd24",2138:"fefa0ee9",2144:"e2c54560",2178:"c5f69987",2237:"aa0692a0",2256:"64ff4d96",2309:"b12a8dd3",2315:"9addf286",2431:"a9d0ebea",2484:"79a6cdcd",2519:"d049e513",2589:"c6d0cebd",2597:"c8a0ad3f",2627:"632ebf44",2917:"91502c44",3027:"03e27833",3105:"40b2b5c6",3138:"dc2f06d4",3162:"57ecb61a",3190:"00173993",3292:"78bfd27e",3347:"384118b8",3359:"0d8a99fd",3417:"e3af77d7",3437:"8500bd3c",3477:"525df931",3550:"9c3130f0",3576:"840bac8a",3633:"95bab85a",3687:"eeba5b2e",4006:"fc22265c",4073:"174695e0",4104:"0b61fb90",4243:"737f2726",4529:"983dcfed",4564:"4f84cce9",4574:"cf9b1b5f",4583:"9993a7c7",4819:"3fa60423",4921:"c6c58a4b",4951:"fbd874db",5163:"13ea7dbc",5359:"8e4b0b5e",5437:"5fa5b140",5503:"3bd940ea",5628:"5a78c9f4",5741:"7580ffe7",5742:"a23de4c8",5799:"dc4a457e",5850:"4143778e",5857:"16d3c52c",5860:"750133d9",5884:"4d0bdadd",5899:"9facaed8",5900:"2527c1c5",6231:"a9ede930",6473:"b65545d7",6619:"f0bf4021",6625:"d0330890",6770:"42e1c95d",6979:"9f2883b5",7098:"5a5b413e",7243:"2a347bb8",7899:"d9ae6ea1",8070:"79540953",8101:"4a156ec1",8146:"21dfc52c",8317:"6263894a",8401:"3a87d252",8846:"c3c78ae0",8926:"1c5c6d23",8989:"29b1d9c8",8995:"ee1ccc92",9048:"c8ddd961",9117:"92f2044a",9180:"632291ce",9495:"be42cbb4",9536:"1d2bb598",9647:"8fbab96d",9840:"695a5436",9947:"dc2b0c61",9951:"e1fd072c"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="docs:",r.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/docs/",r.gca=function(e){return e={17896441:"8401",a65f7afd:"53",fd5d3f69:"382",e73018c5:"545",cd17f53f:"598",c57c8e3d:"613","1334a6b9":"636","944a6f01":"940","4e0d1431":"1049","8e53799d":"1169",a7456010:"1235","2d6b3abf":"1297","852ad0b5":"1358","4998527c":"1378",ac3cc3f5:"1488","9a539b0e":"1621","92852ade":"1625",daa8ef3b:"1635","5043549d":"1899",ddff8a46:"1932","1a4e3797":"2138","4def2e36":"2178","11b43341":"2256","98ff8580":"2309",bdef5384:"2484",d1a9398a:"2589",c5b3f5ce:"2597","71c3de18":"2627","2be17892":"2917",ea4c02b1:"3027","001c3fda":"3105","61cee229":"3138","20bf0014":"3162","8f6ee0c6":"3190",b5257597:"3347",a8dfb490:"3359","8e1b9ec5":"3437",f8b89776:"3576","792c8e11":"3633","35c21b4c":"4006",ae15d4dd:"4243","1e3dcad6":"4574","1df93b7f":"4583",df53a957:"4819","138e0e15":"4921","4d9dc338":"4951","90e0e748":"5359","077a73ed":"5437",e6ba45fe:"5503",aba21aa0:"5742","7c524999":"5799","9c8fcee4":"5850",b2a6176d:"5884",a09c2993:"5899","99171cef":"5900",cc2a131f:"6231","4c5e977b":"6473","3d50c95e":"6619",c60b12b2:"6979",a7bd4aaa:"7098","46aa36fa":"7243","0480b142":"8070","91ee6e85":"8101","7c914a69":"8317",c2c0fda6:"8926",a94703ab:"9048","75a4143c":"9117","20aea505":"9180","0d2c3858":"9536","5e95c892":"9647","85848f1c":"9840","344736af":"9947","10aca893":"9951"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,c)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=r.p+r.u(a),t=new Error;r.l(b,(c=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",t.name="ChunkLoadError",t.type=d,t.request=b,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],t=c[1],o=c[2],n=0;if(b.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(c);n{"use strict";var e,a,c,d,f,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,r),c.loaded=!0,c.exports}r.m=b,e=[],r.O=(a,c,d,f)=>{if(!c){var b=1/0;for(i=0;i=f)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[c,d,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var b={};a=a||[null,c({}),c([]),c(c)];for(var t=2&d&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(f,b),f},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"a65f7afd",382:"fd5d3f69",545:"e73018c5",598:"cd17f53f",613:"c57c8e3d",636:"1334a6b9",940:"944a6f01",1049:"4e0d1431",1169:"8e53799d",1235:"a7456010",1297:"2d6b3abf",1358:"852ad0b5",1378:"4998527c",1488:"ac3cc3f5",1621:"9a539b0e",1625:"92852ade",1635:"daa8ef3b",1899:"5043549d",1932:"ddff8a46",2138:"1a4e3797",2178:"4def2e36",2256:"11b43341",2309:"98ff8580",2484:"bdef5384",2589:"d1a9398a",2597:"c5b3f5ce",2627:"71c3de18",2917:"2be17892",3027:"ea4c02b1",3105:"001c3fda",3138:"61cee229",3162:"20bf0014",3190:"8f6ee0c6",3347:"b5257597",3359:"a8dfb490",3437:"8e1b9ec5",3576:"f8b89776",3633:"792c8e11",4006:"35c21b4c",4243:"ae15d4dd",4574:"1e3dcad6",4583:"1df93b7f",4819:"df53a957",4921:"138e0e15",4951:"4d9dc338",5359:"90e0e748",5437:"077a73ed",5503:"e6ba45fe",5742:"aba21aa0",5799:"7c524999",5850:"9c8fcee4",5884:"b2a6176d",5899:"a09c2993",5900:"99171cef",6231:"cc2a131f",6473:"4c5e977b",6619:"3d50c95e",6979:"c60b12b2",7098:"a7bd4aaa",7243:"46aa36fa",8070:"0480b142",8101:"91ee6e85",8317:"7c914a69",8401:"17896441",8926:"c2c0fda6",9048:"a94703ab",9117:"75a4143c",9180:"20aea505",9536:"0d2c3858",9647:"5e95c892",9840:"85848f1c",9947:"344736af",9951:"10aca893"}[e]||e)+"."+{53:"9b96f3a2",141:"11efc51f",382:"ad859703",489:"79124cfe",495:"67860476",545:"19afc6d0",598:"cbd1e5f9",604:"e9498d4b",613:"f4bfbd88",636:"a5088088",940:"841fe639",971:"d6c5a2f3",1049:"c3d19b98",1169:"ff63513c",1176:"ff3ff93c",1235:"db4ccd1a",1297:"fa71428f",1329:"7168e9f9",1358:"e729e815",1378:"af14d31e",1488:"f5f8e859",1621:"e4c3d27b",1625:"7cdc287f",1635:"c8d2bcb3",1689:"81a43fd6",1899:"1a676e99",1932:"41ab7e8d",1987:"3dafef79",2130:"4a68cd24",2138:"fefa0ee9",2144:"e2c54560",2178:"50a24d08",2237:"aa0692a0",2256:"64ff4d96",2309:"b12a8dd3",2315:"9addf286",2431:"a9d0ebea",2484:"75159869",2519:"d049e513",2589:"1d0b391f",2597:"22e92835",2627:"c3985694",2917:"8da8276a",3027:"03e27833",3105:"fd051a2c",3138:"6c87e655",3162:"adfb3a3c",3190:"8a0f22f8",3292:"78bfd27e",3347:"384118b8",3359:"0a88ca81",3417:"e3af77d7",3437:"78cf7205",3477:"525df931",3550:"9c3130f0",3576:"ffd69768",3633:"21f032f3",3687:"eeba5b2e",4006:"16080f63",4073:"174695e0",4104:"0b61fb90",4243:"8df9d1f2",4529:"983dcfed",4564:"4f84cce9",4574:"d1a94968",4583:"9993a7c7",4819:"2724bda0",4921:"c6c58a4b",4951:"a9578262",5163:"13ea7dbc",5359:"c411dcd3",5437:"311af8ef",5503:"d1790090",5628:"5a78c9f4",5741:"7580ffe7",5742:"a23de4c8",5799:"dc4a457e",5850:"2ca4f91c",5857:"16d3c52c",5860:"750133d9",5884:"df53c8fd",5899:"9facaed8",5900:"44557f52",6231:"17249466",6473:"b65545d7",6619:"83723eeb",6625:"d0330890",6770:"42e1c95d",6979:"0e50cb08",7098:"5a5b413e",7243:"d0ad9f8c",7899:"d9ae6ea1",8070:"79540953",8101:"4a156ec1",8146:"21dfc52c",8317:"ecc4baaf",8401:"3a87d252",8846:"c3c78ae0",8926:"e6ce0207",8989:"29b1d9c8",8995:"ee1ccc92",9048:"c8ddd961",9117:"45a0e1e0",9180:"565d80e2",9495:"be42cbb4",9536:"5c1a3b73",9647:"8fbab96d",9840:"8c5b2da9",9947:"dc2b0c61",9951:"9d0ec706"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),d={},f="docs:",r.l=(e,a,c,b)=>{if(d[e])d[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=d[e];if(delete d[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/docs/",r.gca=function(e){return e={17896441:"8401",a65f7afd:"53",fd5d3f69:"382",e73018c5:"545",cd17f53f:"598",c57c8e3d:"613","1334a6b9":"636","944a6f01":"940","4e0d1431":"1049","8e53799d":"1169",a7456010:"1235","2d6b3abf":"1297","852ad0b5":"1358","4998527c":"1378",ac3cc3f5:"1488","9a539b0e":"1621","92852ade":"1625",daa8ef3b:"1635","5043549d":"1899",ddff8a46:"1932","1a4e3797":"2138","4def2e36":"2178","11b43341":"2256","98ff8580":"2309",bdef5384:"2484",d1a9398a:"2589",c5b3f5ce:"2597","71c3de18":"2627","2be17892":"2917",ea4c02b1:"3027","001c3fda":"3105","61cee229":"3138","20bf0014":"3162","8f6ee0c6":"3190",b5257597:"3347",a8dfb490:"3359","8e1b9ec5":"3437",f8b89776:"3576","792c8e11":"3633","35c21b4c":"4006",ae15d4dd:"4243","1e3dcad6":"4574","1df93b7f":"4583",df53a957:"4819","138e0e15":"4921","4d9dc338":"4951","90e0e748":"5359","077a73ed":"5437",e6ba45fe:"5503",aba21aa0:"5742","7c524999":"5799","9c8fcee4":"5850",b2a6176d:"5884",a09c2993:"5899","99171cef":"5900",cc2a131f:"6231","4c5e977b":"6473","3d50c95e":"6619",c60b12b2:"6979",a7bd4aaa:"7098","46aa36fa":"7243","0480b142":"8070","91ee6e85":"8101","7c914a69":"8317",c2c0fda6:"8926",a94703ab:"9048","75a4143c":"9117","20aea505":"9180","0d2c3858":"9536","5e95c892":"9647","85848f1c":"9840","344736af":"9947","10aca893":"9951"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,c)=>{var d=r.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>d=e[a]=[c,f]));c.push(d[2]=f);var b=r.p+r.u(a),t=new Error;r.l(b,(c=>{if(r.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var f=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",t.name="ChunkLoadError",t.type=f,t.request=b,d[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var d,f,b=c[0],t=c[1],o=c[2],n=0;if(b.some((a=>0!==e[a]))){for(d in t)r.o(t,d)&&(r.m[d]=t[d]);if(o)var i=o(r)}for(a&&a(c);n FAQ | D&D 5e SRD API - + diff --git a/graphql.html b/graphql.html index a055007..f8c86b5 100644 --- a/graphql.html +++ b/graphql.html @@ -4,7 +4,7 @@ GraphQL | D&D 5e SRD API - + diff --git a/index.html b/index.html index 22b76e0..2f05f19 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ D&D 5e SRD API | D&D 5e SRD API - + diff --git a/introduction.html b/introduction.html index 6d33cf1..7f1f14b 100644 --- a/introduction.html +++ b/introduction.html @@ -4,7 +4,7 @@ Introduction | D&D 5e SRD API - + diff --git a/reference/schemas.html b/reference/schemas.html index 3294904..ce4c01e 100644 --- a/reference/schemas.html +++ b/reference/schemas.html @@ -4,7 +4,7 @@ Schemas | D&D 5e SRD API - + diff --git a/reference/status-page.html b/reference/status-page.html index e394cab..a0e4a02 100644 --- a/reference/status-page.html +++ b/reference/status-page.html @@ -4,7 +4,7 @@ Status Page | D&D 5e SRD API - + diff --git a/search.html b/search.html index 457fe45..5d0efcd 100644 --- a/search.html +++ b/search.html @@ -4,7 +4,7 @@ Search the documentation - + diff --git a/tutorials.html b/tutorials.html index f8d1cea..e4f54c1 100644 --- a/tutorials.html +++ b/tutorials.html @@ -4,7 +4,7 @@ Tutorials | D&D 5e SRD API - + diff --git a/tutorials/advanced/monster-search-with-javascript.html b/tutorials/advanced/monster-search-with-javascript.html index d164b8f..941434b 100644 --- a/tutorials/advanced/monster-search-with-javascript.html +++ b/tutorials/advanced/monster-search-with-javascript.html @@ -4,7 +4,7 @@ Interactive Monster Search with JavaScript | D&D 5e SRD API - + diff --git a/tutorials/advanced/react-spell-cards.html b/tutorials/advanced/react-spell-cards.html index 3d7b097..c170ce5 100644 --- a/tutorials/advanced/react-spell-cards.html +++ b/tutorials/advanced/react-spell-cards.html @@ -4,7 +4,7 @@ Creating a Spell Card Library with React | D&D 5e SRD API - + diff --git a/tutorials/advanced/terminal-spellbook-with-python.html b/tutorials/advanced/terminal-spellbook-with-python.html index 71d4ad9..0a6d5e4 100644 --- a/tutorials/advanced/terminal-spellbook-with-python.html +++ b/tutorials/advanced/terminal-spellbook-with-python.html @@ -4,7 +4,7 @@ Command Line Spellbook with Python | D&D 5e SRD API - + diff --git a/tutorials/basic/discover-dnd-races-with-shell-scripting.html b/tutorials/basic/discover-dnd-races-with-shell-scripting.html index 77b5923..9c04f6c 100644 --- a/tutorials/basic/discover-dnd-races-with-shell-scripting.html +++ b/tutorials/basic/discover-dnd-races-with-shell-scripting.html @@ -4,7 +4,7 @@ Discover D&D Races with Shell Scripting | D&D 5e SRD API - + diff --git a/tutorials/beginner/getting-started.html b/tutorials/beginner/getting-started.html index 7bbd737..166ffc7 100644 --- a/tutorials/beginner/getting-started.html +++ b/tutorials/beginner/getting-started.html @@ -4,7 +4,7 @@ Getting Started | D&D 5e SRD API - + diff --git a/tutorials/beginner/graphql.html b/tutorials/beginner/graphql.html index 247af8b..0a3e6da 100644 --- a/tutorials/beginner/graphql.html +++ b/tutorials/beginner/graphql.html @@ -4,7 +4,7 @@ GraphQL Fundamentals | D&D 5e SRD API - +