Module: save_request

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from pydantic import BaseModel


class RecordDict(BaseModel):
    """Dict representation of the record."""

    _t: str
    """Type name."""

    class Config:
        extra = "allow"


class SaveRequest(BaseModel):
    """Request data type for the /entity/save route."""

    record_dict: RecordDict
    """Dict representation of the record to be saved/updated."""

    old_record_key: str | None = None
    """Optional key of the record to be updated."""

    dataset: str | None = None
    """Dataset string."""

    user: str | None = None
    """Dataset string."""

Classes

class RecordDict (**data: Any)

Dict representation of the record.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class RecordDict(BaseModel):
    """Dict representation of the record."""

    _t: str
    """Type name."""

    class Config:
        extra = "allow"

Ancestors

pydantic.main.BaseModel

Class variables

var Config
var model_computed_fields
var model_config
var model_fields

Methods

def model_post_init(self: BaseModel, context: Any, /)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Args

self: The BaseModel instance.
context: The context.

class SaveRequest (**data: Any)

Request data type for the /entity/save route.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class SaveRequest(BaseModel):
    """Request data type for the /entity/save route."""

    record_dict: RecordDict
    """Dict representation of the record to be saved/updated."""

    old_record_key: str | None = None
    """Optional key of the record to be updated."""

    dataset: str | None = None
    """Dataset string."""

    user: str | None = None
    """Dataset string."""

Ancestors

pydantic.main.BaseModel

Class variables

var dataset: Dataset string.
var model_computed_fields
var model_config
var model_fields
var old_record_key: Optional key of the record to be updated.
var record_dict: Dict representation of the record to be saved/updated.
var user: Dataset string.