Skip to main content

VendorCreateRequest

Request wrapper for VendorCreate with validation and JSON:API support. Combines the VendorCreate data model with client request functionality, providing automatic validation and JSON:API format conversion for API requests.

Fields

FieldTypeRequiredDefaultDescription
namestrPydanticUndefined-
descriptionForwardRef('Optional[Any]')None-
questionnaire_idsForwardRef('Optional[List[str]]')None-

Usage Example

from credoai.models import VendorCreateRequest

# Create a new instance
model = VendorCreateRequest(
name="example_value", # Required field
)

# Convert to dictionary
model_dict = model.model_dump()
print(model_dict)

# Create from dictionary
data = {
"name": "example_value",
}
model_from_dict = VendorCreateRequest(**data)

JSON Schema

{
"type": "object",
"title": "VendorCreateRequest",
"description": "Request wrapper for VendorCreate with validation and JSON:API support.
Combines the VendorCreate data model with client request functionality,
providing automatic validation and JSON:API format conversion for API requests.",
"properties": {
"name": {
"type": "str"
},
"description": {
"type": "forwardref('optional[any]')"
},
"questionnaire_ids": {
"type": "forwardref('optional[list[str]]')"
}
},
"required": ["name", ]
}