ContractFormatResponse
Response from contract formatting
Properties
| Property | Type | Required | Description |
|---|---|---|---|
status | string | ✅ Yes | Status: 'success' or 'error' |
format | string | ✅ Yes | Output format |
content | object | ❌ No | Formatted content or file path |
filename | object | ❌ No | Generated filename |
error | object | ❌ No | Error message if status is 'error' |
Example
{
"status": "example",
"format": "example",
"content": {},
"filename": {},
"error": {}
}Used In
Code Examples
TypeScript
interface ContractFormatResponse {
status: string;
format: string;
content?: any;
filename?: any;
error?: any;
}
// Usage example
const data: ContractFormatResponse = {
"status": "example",
"format": "example",
"content": {},
"filename": {},
"error": {}
};Python
from data_layer.schemas import ContractFormatResponse
# Create instance
data = ContractFormatResponse(
# Add your field values here
)cURL
curl -X POST "https://altsportsleagues-backend-2qcdjegnaa-uc.a.run.app/api/endpoint" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{ "status": "example", "format": "example", "content": {}, "filename": {}, "error": {} }'Validation Rules
Required Fields: status, format
Additional Information
- Type: object
- Source: Generated from Pydantic models in
data_layer/schemas/ - Auto-validated: All fields are validated by FastAPI
This documentation is auto-generated from the OpenAPI specification.