# {py:mod}`labthings_fastapi.thing_description`

```{py:module} labthings_fastapi.thing_description
```

```{autodoc2-docstring} labthings_fastapi.thing_description
:allowtitles:
```

## Submodules

```{toctree}
:titlesonly:
:maxdepth: 1

labthings_fastapi.thing_description.model
labthings_fastapi.thing_description.validation
```

## Package Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`is_a_reference <labthings_fastapi.thing_description.is_a_reference>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.is_a_reference
    :summary:
    ```
* - {py:obj}`look_up_reference <labthings_fastapi.thing_description.look_up_reference>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.look_up_reference
    :summary:
    ```
* - {py:obj}`is_an_object <labthings_fastapi.thing_description.is_an_object>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.is_an_object
    :summary:
    ```
* - {py:obj}`convert_object <labthings_fastapi.thing_description.convert_object>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.convert_object
    :summary:
    ```
* - {py:obj}`convert_anyof <labthings_fastapi.thing_description.convert_anyof>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.convert_anyof
    :summary:
    ```
* - {py:obj}`convert_prefixitems <labthings_fastapi.thing_description.convert_prefixitems>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.convert_prefixitems
    :summary:
    ```
* - {py:obj}`convert_additionalproperties <labthings_fastapi.thing_description.convert_additionalproperties>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.convert_additionalproperties
    :summary:
    ```
* - {py:obj}`check_recursion <labthings_fastapi.thing_description.check_recursion>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.check_recursion
    :summary:
    ```
* - {py:obj}`jsonschema_to_dataschema <labthings_fastapi.thing_description.jsonschema_to_dataschema>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.jsonschema_to_dataschema
    :summary:
    ```
* - {py:obj}`type_to_dataschema <labthings_fastapi.thing_description.type_to_dataschema>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.type_to_dataschema
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`JSONSchema <labthings_fastapi.thing_description.JSONSchema>`
  - ```{autodoc2-docstring} labthings_fastapi.thing_description.JSONSchema
    :summary:
    ```
````

### API

````{py:data} JSONSchema
:canonical: labthings_fastapi.thing_description.JSONSchema
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.thing_description.JSONSchema
```

````

````{py:function} is_a_reference(d: labthings_fastapi.thing_description.JSONSchema) -> bool
:canonical: labthings_fastapi.thing_description.is_a_reference

```{autodoc2-docstring} labthings_fastapi.thing_description.is_a_reference
```
````

````{py:function} look_up_reference(reference: str, d: labthings_fastapi.thing_description.JSONSchema) -> labthings_fastapi.thing_description.JSONSchema
:canonical: labthings_fastapi.thing_description.look_up_reference

```{autodoc2-docstring} labthings_fastapi.thing_description.look_up_reference
```
````

````{py:function} is_an_object(d: labthings_fastapi.thing_description.JSONSchema) -> bool
:canonical: labthings_fastapi.thing_description.is_an_object

```{autodoc2-docstring} labthings_fastapi.thing_description.is_an_object
```
````

````{py:function} convert_object(d: labthings_fastapi.thing_description.JSONSchema) -> labthings_fastapi.thing_description.JSONSchema
:canonical: labthings_fastapi.thing_description.convert_object

```{autodoc2-docstring} labthings_fastapi.thing_description.convert_object
```
````

````{py:function} convert_anyof(d: labthings_fastapi.thing_description.JSONSchema) -> labthings_fastapi.thing_description.JSONSchema
:canonical: labthings_fastapi.thing_description.convert_anyof

```{autodoc2-docstring} labthings_fastapi.thing_description.convert_anyof
```
````

````{py:function} convert_prefixitems(d: labthings_fastapi.thing_description.JSONSchema) -> labthings_fastapi.thing_description.JSONSchema
:canonical: labthings_fastapi.thing_description.convert_prefixitems

```{autodoc2-docstring} labthings_fastapi.thing_description.convert_prefixitems
```
````

````{py:function} convert_additionalproperties(d: labthings_fastapi.thing_description.JSONSchema) -> labthings_fastapi.thing_description.JSONSchema
:canonical: labthings_fastapi.thing_description.convert_additionalproperties

```{autodoc2-docstring} labthings_fastapi.thing_description.convert_additionalproperties
```
````

````{py:function} check_recursion(depth: int, limit: int)
:canonical: labthings_fastapi.thing_description.check_recursion

```{autodoc2-docstring} labthings_fastapi.thing_description.check_recursion
```
````

````{py:function} jsonschema_to_dataschema(d: labthings_fastapi.thing_description.JSONSchema, root_schema: typing.Optional[labthings_fastapi.thing_description.JSONSchema] = None, recursion_depth: int = 0, recursion_limit: int = 99) -> labthings_fastapi.thing_description.JSONSchema
:canonical: labthings_fastapi.thing_description.jsonschema_to_dataschema

```{autodoc2-docstring} labthings_fastapi.thing_description.jsonschema_to_dataschema
```
````

````{py:function} type_to_dataschema(t: type, **kwargs) -> labthings_fastapi.thing_description.model.DataSchema
:canonical: labthings_fastapi.thing_description.type_to_dataschema

```{autodoc2-docstring} labthings_fastapi.thing_description.type_to_dataschema
```
````