alti_api.versions.v1_0.models.resources module¶

Models used for the resources endpoints

class alti_api.versions.v1_0.models.resources.BboxModel(*, east: float, north: float, west: float, south: float)¶

Bases : BaseModel

Model to create bbox property

east: float¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'east': FieldInfo(annotation=float, required=True), 'north': FieldInfo(annotation=float, required=True), 'south': FieldInfo(annotation=float, required=True), 'west': FieldInfo(annotation=float, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

north: float¶

south: float¶

west: float¶

class alti_api.versions.v1_0.models.resources.CheckResourcesPyramids(resource_mgr, resource, pyramid=None)¶

Bases : object

Checking the validity of resources and pyramids

__init__(resource_mgr, resource, pyramid=None)¶

async check_existing_pyramid(error_if_exists: bool) → ErrorException | None¶

Check if a pyramid exists for a resource

Paramètres:: error_if_exists – If true, raises an error if the pyramid exists. If false, raises an error if the pyramid does not exist.
Renvoie:: ErrorException or None

async check_existing_resource(error_if_exists: bool) → ErrorException | None¶

Check if a resource exists

Paramètres:: error_if_exists – If true, raises an error if the resource exists. If false, raises an error if the resource does not exist.
Renvoie:: ErrorException or None

class alti_api.versions.v1_0.models.resources.CreateUpdatePyramidRequest(*, stored_data: StoredDataModel, title: str, bbox: BboxModel | None = None, source: SourceAccuracyValueModel | SourceAccuracyMappingModel, accuracy: SourceAccuracyMappingModel | SourceAccuracyValueModel, **extra_data: Any)¶

Bases : BaseModel

Parameters to create or update a pyramid in an existing resource (in used_data property)

accuracy: SourceAccuracyMappingModel | SourceAccuracyValueModel¶

bbox: BboxModel | None¶

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'accuracy': FieldInfo(annotation=Union[SourceAccuracyMappingModel, SourceAccuracyValueModel], required=True), 'bbox': FieldInfo(annotation=Union[BboxModel, NoneType], required=False), 'source': FieldInfo(annotation=Union[SourceAccuracyValueModel, SourceAccuracyMappingModel], required=True), 'stored_data': FieldInfo(annotation=StoredDataModel, required=True), 'title': FieldInfo(annotation=str, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

source: SourceAccuracyValueModel | SourceAccuracyMappingModel¶

stored_data: StoredDataModel¶

title: str¶

class alti_api.versions.v1_0.models.resources.CreateUpdateResourceRequest(*, _id: str, title: str, abstract: str, keywords: list[str] | None = None, bbox: BboxModel | None = None, used_data: list[CreateUpdatePyramidRequest], **extra_data: Any)¶

Bases : BaseModel

Parameters to create or update a resource with pyramids

abstract: str¶

bbox: BboxModel | None¶

id: str¶

keywords: list[str] | None¶

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'abstract': FieldInfo(annotation=str, required=True), 'bbox': FieldInfo(annotation=Union[BboxModel, NoneType], required=False), 'id': FieldInfo(annotation=str, required=True, alias='_id', alias_priority=2), 'keywords': FieldInfo(annotation=Union[list[str], NoneType], required=False), 'title': FieldInfo(annotation=str, required=True), 'used_data': FieldInfo(annotation=list[CreateUpdatePyramidRequest], required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

title: str¶

used_data: list[CreateUpdatePyramidRequest]¶

class alti_api.versions.v1_0.models.resources.ExtentModel(*, geometry: dict, type: str)¶

Bases : BaseModel

Model to create extent property

geometry: dict¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'geometry': FieldInfo(annotation=dict, required=True), 'type': FieldInfo(annotation=str, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

type: str¶

class alti_api.versions.v1_0.models.resources.MappingModel(*, field_example_1: str | None = None, field_example_2: str | None = None, field_example_3: str | None = None, field_example_4: str | None = None, field_example_5: str | None = None, **extra_data: Any)¶

Bases : BaseModel

Model to create source or accuracy property using a mapping value

field_example_1: str | None¶

field_example_2: str | None¶

field_example_3: str | None¶

field_example_4: str | None¶

field_example_5: str | None¶

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'field_example_1': FieldInfo(annotation=Union[str, NoneType], required=False, exclude=True), 'field_example_2': FieldInfo(annotation=Union[str, NoneType], required=False, exclude=True), 'field_example_3': FieldInfo(annotation=Union[str, NoneType], required=False, exclude=True), 'field_example_4': FieldInfo(annotation=Union[str, NoneType], required=False, exclude=True), 'field_example_5': FieldInfo(annotation=Union[str, NoneType], required=False, exclude=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class alti_api.versions.v1_0.models.resources.ResponseCreatePyramidRequest(*, content: str)¶

Bases : BaseModel

Response when a pyramid has been created

content: str¶

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'example': {'content': 'Pyramid rgealti_pyramid1 created for resource RGEALTI'}}}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'content': FieldInfo(annotation=str, required=True, json_schema_extra={'example': 'Pyramid rgealti_pyramid1 created for resource RGEALTI'})}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class alti_api.versions.v1_0.models.resources.ResponseCreateResourceRequest(*, content: str)¶

Bases : BaseModel

Response when a resource has been created

content: str¶

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'example': {'content': 'Resource RGEALTI created'}}}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'content': FieldInfo(annotation=str, required=True, json_schema_extra={'example': 'Resource RGEALTI created'})}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class alti_api.versions.v1_0.models.resources.ResponseDeletePyramidRequest(*, content: str)¶

Bases : BaseModel

Response when a pyramid has been deleted

content: str¶

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'example': {'content': 'Pyramid rgealti_pyramid1 deleted for resource RGEALTI'}}}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'content': FieldInfo(annotation=str, required=True, json_schema_extra={'example': 'Pyramid rgealti_pyramid1 deleted for resource RGEALTI'})}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class alti_api.versions.v1_0.models.resources.ResponseDeleteResourceRequest(*, content: str)¶

Bases : BaseModel

Response when a resource has been deleted

content: str¶

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'example': {'content': 'Resource RGEALTI deleted'}}}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'content': FieldInfo(annotation=str, required=True, json_schema_extra={'example': 'Resource RGEALTI deleted'})}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class alti_api.versions.v1_0.models.resources.ResponseGetResourceRequest(*, content: CreateUpdateResourceRequest)¶

Bases : BaseModel

Response when a resource has been retrieved

content: CreateUpdateResourceRequest¶

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'example': {'default_pyramid': 'string', 'layer_name': 'RGEALTI', 'pyramids': {'string': {'bbox': {'east': 0.0, 'north': 0.0, 'south': 0.0, 'west': 0.0}, 'path': 'string', 'stored_data': 'string', 'title': 'string'}}, 'type_infos': {'abstract': 'string', 'bbox': {'east': 0.0, 'north': 0.0, 'south': 0.0, 'west': 0.0}, 'keywords': ['string'], 'title': 'string'}}}}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'content': FieldInfo(annotation=CreateUpdateResourceRequest, required=True, json_schema_extra={'example': {'layer_name': 'RGEALTI', 'default_pyramid': 'string', 'type_infos': {'title': 'string', 'abstract': 'string', 'keywords': ['string'], 'bbox': {'east': 0.0, 'north': 0.0, 'west': 0.0, 'south': 0.0}}, 'pyramids': {'string': {'stored_data': 'string', 'title': 'string', 'path': 'string', 'bbox': {'east': 0.0, 'north': 0.0, 'west': 0.0, 'south': 0.0}}}}})}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class alti_api.versions.v1_0.models.resources.ResponseGetResourcesRequest(*, content: str, resources: dict[str, CreateUpdateResourceRequest])¶

Bases : BaseModel

Response when resources has been retrieved

content: str¶

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'example': {'content': '1 resource for the specified keywords', 'resources': [{'default_pyramid': 'string', 'layer_name': 'RGEALTI', 'pyramids': {'string': {'bbox': {'east': 0.0, 'north': 0.0, 'south': 0.0, 'west': 0.0}, 'path': 'string', 'stored_data': 'string', 'title': 'string'}}, 'type_infos': {'abstract': 'string', 'bbox': {'east': 0.0, 'north': 0.0, 'south': 0.0, 'west': 0.0}, 'keywords': ['string'], 'title': 'string'}}]}}}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'content': FieldInfo(annotation=str, required=True, json_schema_extra={'example': '1 resource for the specified keywords'}), 'resources': FieldInfo(annotation=dict[str, CreateUpdateResourceRequest], required=True, json_schema_extra={'example': [{'layer_name': 'RGEALTI', 'default_pyramid': 'string', 'type_infos': {'title': 'string', 'abstract': 'string', 'keywords': ['string'], 'bbox': {'east': 0.0, 'north': 0.0, 'west': 0.0, 'south': 0.0}}, 'pyramids': {'string': {'stored_data': 'string', 'title': 'string', 'path': 'string', 'bbox': {'east': 0.0, 'north': 0.0, 'west': 0.0, 'south': 0.0}}}}]})}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

resources: dict[str, CreateUpdateResourceRequest]¶

class alti_api.versions.v1_0.models.resources.ResponseUpdatePyramidRequest(*, content: str)¶

Bases : BaseModel

Response when a pyramid has been updated

content: str¶

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'example': {'content': 'Pyramid rgealti_pyramid1 updated for resource RGEALTI'}}}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'content': FieldInfo(annotation=str, required=True, json_schema_extra={'example': 'Pyramid rgealti_pyramid1 updated for resource RGEALTI'})}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class alti_api.versions.v1_0.models.resources.ResponseUpdateResourceRequest(*, content: str)¶

Bases : BaseModel

Response when a resource has been updated

content: str¶

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'example': {'content': 'Resource RGEALTI updated'}}}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'content': FieldInfo(annotation=str, required=True, json_schema_extra={'example': 'Resource RGEALTI updated'})}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class alti_api.versions.v1_0.models.resources.SourceAccuracyMappingModel(*, stored_data: StoredDataModel, mapping: MappingModel, **extra_data: Any)¶

Bases : BaseModel

Model to create source or accuracy property using a stored_data and mapping values

mapping: MappingModel¶

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mapping': FieldInfo(annotation=MappingModel, required=True), 'stored_data': FieldInfo(annotation=StoredDataModel, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

stored_data: StoredDataModel¶

class alti_api.versions.v1_0.models.resources.SourceAccuracyValueModel(*, value: str, **extra_data: Any)¶

Bases : BaseModel

Model to create source or accuracy property using a defined value

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'value': FieldInfo(annotation=str, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

value: str¶

class alti_api.versions.v1_0.models.resources.StoredDataModel(*, _id: str, ancestors: list[str] | None = None, extent: ExtentModel | None = None, name: str | None = None, size: int | None = None, srs: str | None = None, status: str | None = None, storage: StoredDataStorageModel, type: str | None = None, type_infos: StoredDataTypeInfosModel, **extra_data: Any)¶

Bases : BaseModel

Model to create stored_data property

ancestors: list[str] | None¶

extent: ExtentModel | None¶

id: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ancestors': FieldInfo(annotation=Union[list[str], NoneType], required=False), 'extent': FieldInfo(annotation=Union[ExtentModel, NoneType], required=False), 'id': FieldInfo(annotation=str, required=True, alias='_id', alias_priority=2), 'name': FieldInfo(annotation=Union[str, NoneType], required=False), 'size': FieldInfo(annotation=Union[int, NoneType], required=False), 'srs': FieldInfo(annotation=Union[str, NoneType], required=False), 'status': FieldInfo(annotation=Union[str, NoneType], required=False), 'storage': FieldInfo(annotation=StoredDataStorageModel, required=True), 'type': FieldInfo(annotation=Union[str, NoneType], required=False), 'type_infos': FieldInfo(annotation=StoredDataTypeInfosModel, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

name: str | None¶

size: int | None¶

srs: str | None¶

status: str | None¶

storage: StoredDataStorageModel¶

type: str | None¶

type_infos: StoredDataTypeInfosModel¶

class alti_api.versions.v1_0.models.resources.StoredDataStorageModel(*, _id: str, name: str, type: str, type_infos: StoredDataStorageTypeInfosModel, **extra_data: Any)¶

Bases : BaseModel

Model to create storage property in the stored_data property

id: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, alias='_id', alias_priority=2), 'name': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True), 'type_infos': FieldInfo(annotation=StoredDataStorageTypeInfosModel, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

name: str¶

type: str¶

type_infos: StoredDataStorageTypeInfosModel¶

class alti_api.versions.v1_0.models.resources.StoredDataStorageTypeInfosModel(*, pot_name: str, **extra_data: Any)¶

Bases : BaseModel

Model to create type_infos property in the storage property of the stored_data property

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'pot_name': FieldInfo(annotation=str, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

pot_name: str¶

class alti_api.versions.v1_0.models.resources.StoredDataTypeInfosModel(*, channels_format: str, channels_number: int, compression: str, levels: list[str], nodata_value: str, tms: str, **extra_data: Any)¶

Bases : BaseModel

Model to create type_infos property in the stored_data property

channels_format: str¶

channels_number: int¶

compression: str¶

levels: list[str]¶

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'channels_format': FieldInfo(annotation=str, required=True), 'channels_number': FieldInfo(annotation=int, required=True), 'compression': FieldInfo(annotation=str, required=True), 'levels': FieldInfo(annotation=list[str], required=True), 'nodata_value': FieldInfo(annotation=str, required=True), 'tms': FieldInfo(annotation=str, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

nodata_value: str¶

tms: str¶