Klineo/Docs
Open app ↗

API schemas

StudyShareRequest

All API schemas

Exactly one of: object; object

Field Required at this level Type Description and constraints
oneOf[1].visibility Yes Constant PRIVATE —
oneOf[1].expiresAt Yes string Format: date-time
oneOf[1].disclosure Yes object Additional properties rejected
oneOf[1].disclosure.includeDrivers Yes boolean —
oneOf[1].disclosure.includeTreasury Yes boolean —
oneOf[1].disclosure.includePolicy Yes boolean —
oneOf[1].reason Yes string Min length: 3; Max length: 500
oneOf[2].slug No string Pattern: ^[a-z0-9][a-z0-9_-]{6,126}[a-z0-9]$; Min length: 8; Max length: 128
oneOf[2].visibility Yes Constant PUBLIC —
oneOf[2].expiresAt Yes string Format: date-time
oneOf[2].disclosure Yes object Additional properties rejected
oneOf[2].disclosure.includeDrivers Yes boolean —
oneOf[2].disclosure.includeTreasury Yes boolean —
oneOf[2].disclosure.includePolicy Yes boolean —
oneOf[2].reason Yes string Min length: 3; Max length: 500

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/StudyShareRequest in the OpenAPI contract.