Search Engine Serilizer Pydantic

search_engine_serializer_pydantic · OCA/search-engine

    Repository
    OCA/search-engine · module folder · Try on Runboat
    Module version
    1.0.0
    Category
    Uncategorized
    Folder size
    0.04 MB
    License
    AGPL-3
    Application
    No
    Auto-installable
    No
    Website
    https://github.com/OCA/search-engine
    Last tracking update
    2026-08-07 08:43:07
    Authors
    ACSONE SA/NV, Odoo Community Association (OCA)
    Maintainers
    ACSONE SA/NV, Odoo Community Association (OCA)
    Committers
    Laurent Mignon (ACSONE), Sébastien BEAU, Weblate, OCA-git-bot, oca-ci
    Odoo dependencies
    OCA/queue:
    - queue_job
    OCA/rest-framework:
    - pydantic
    OCA/search-engine:
    - connector_search_engine
    OCA/server-env:
    - server_environment
    OCA/server-tools:
    - base_partition
    odoo/odoo:
    - mail
    - base
    - base_setup
    - web
    - bus
    - web_tour
    - html_editor
    - base_sparse_field
    Python dependencies
    pydantic, typing-extensions, unidecode, requests, contextvars, pydantic>=2.0.0
    System dependencies
    None
    Required by
    oca_search_engine
    Description
    This module is a technical module that define a new abstract class named
`PydandicModelSerializer` that inherit from
`odoo.addons.connector_search_engine.tools.serializer.ModelSerializer`

This new class define a new abstract method `get_model_class`. This method is used by
the index to get the Pydantic model class to use to generate the json schema.

On the index form, if the serializer is a `PydanticModelSerializer`, a field is
displayed to display the related json schema and therefore provide documentation about
the fields exported and their characteristics.

    Code Analysis ⓘ

    Views touched (1)
    XML IDNameModelTypeStatus
    se_index_form_view se.index.form se.index form Inherits connector_search_engine.se_index_form_view
    HTTP endpoints (0)

    No HTTP endpoints found for this module.

    Models touched (1)

    New fields (3)
    • is_pydantic_serializer Boolean
      compute='_compute_is_pydantic_serializer' store=False string='Is a Serializer based on Pydantic Model?'
    • record_json_schema Serialized
      compute='_compute_record_json_schema' store=False string='JSON Schema of a record stored in this index (as dict)'
    • record_json_schema_str Char
      compute='_compute_record_json_schema' store=False string='JSON Schema of a record stored in this index'
    Public methods (0)

    No public methods.

    Loading…