dto.data

Data-related DTOs for SecretVaults API.

class CreateStandardDataRequest(*, collection: Uuid, data: List[Dict[str, Any]])

Bases: BaseModel

Request model for creating standard (non-owned) data in a collection.

collection: Uuid

data: List[Dict[str, Any]]

class CreateOwnedDataRequest(*, collection: Uuid, data: List[Dict[str, Any]], owner: Did, acl: AclDto)

Bases: BaseModel

Request model for creating owned data in a collection, specifying owner and ACL.

collection: Uuid

data: List[Dict[str, Any]]

owner: Did

acl: AclDto

class CreateDataError(*, error: str, document: Any)

Bases: BaseModel

Error details for a failed data creation attempt.

error: str

document: Any

class CreateDataResponseData(*, created: List[Uuid], errors: List[CreateDataError])

Bases: BaseModel

Response data for a data creation request, including created IDs and errors.

created: List[Uuid]

errors: List[CreateDataError]

class CreateDataResponse(*, data: CreateDataResponseData)

Bases: BaseModel

Response model for a data creation request.

data: CreateDataResponseData

class UpdateDataRequest(*, collection: Uuid, filter: Dict[str, Any], update: Dict[str, Any])

Bases: BaseModel

Request model for updating data in a collection.

collection: Uuid

filter: Dict[str, Any]

update: Dict[str, Any]

class UpdateDataResponseData(*, acknowledged: bool, matched: int, modified: int, upserted: int, upserted_id: str | None = None)

Bases: BaseModel

Response data for a data update request, including counts and upserted ID.

acknowledged: bool

matched: int

modified: int

upserted: int

upserted_id: str | None

class UpdateDataResponse(*, data: UpdateDataResponseData)

Bases: BaseModel

Response model for a data update request.

data: UpdateDataResponseData

class FindDataRequest(*, collection: Uuid, filter: Dict[str, Any])

Bases: BaseModel

Request model for finding data in a collection using a filter.

collection: Uuid

filter: Dict[str, Any]

class FindDataResponse(*, data: List[Dict[str, Any]])

Bases: BaseModel

Response model for a data find request, returning a list of documents.

data: List[Dict[str, Any]]

class DeleteDataRequest(*, collection: Uuid, filter: Dict[str, Any])

Bases: BaseModel

Request model for deleting data in a collection using a filter.

collection: Uuid

filter: Dict[str, Any]

class DeleteDataResponseData(*, acknowledged: bool, deletedCount: int)

Bases: BaseModel

Response data for a data deletion request, including count of deleted documents.

acknowledged: bool

deletedCount: int

class DeleteDataResponse(*, data: DeleteDataResponseData)

Bases: BaseModel

Response model for a data deletion request.

data: DeleteDataResponseData

class FlushDataRequest(*, collection: Uuid)

Bases: BaseModel

Request model for flushing all data in a collection.

collection: Uuid

class DataSchemaByIdRequestParams(*, id: Uuid)

Bases: BaseModel

Request parameters for retrieving a data schema by ID.

id: Uuid

class TailDataRequest(*, id: Uuid, limit: Annotated[int, Le(le=1000)] = 10)

Bases: BaseModel

Request model for tailing the last N documents in a collection.

id: Uuid

limit: int

class TailDataResponse(*, data: List[Dict[str, Any]])

Bases: BaseModel

Response model for a tail data request, returning a list of documents.

data: List[Dict[str, Any]]