|
5 | 5 |
|
6 | 6 |
|
7 | 7 | class TransferFamilyAuthorizer(BaseModel):
|
8 |
| - username: str |
9 |
| - password: Optional[str] = None |
10 |
| - protocol: Literal["SFTP", "FTP", "FTPS"] |
11 |
| - server_id: str = Field(..., alias="serverId") |
12 |
| - source_ip: IPvAnyAddress = Field(..., alias="sourceIp") |
| 8 | + username: str = Field( |
| 9 | + description="The username of the user attempting to authenticate.", |
| 10 | + examples=["bobusa", "john.doe", "sftp-user-123", "data-transfer-user"], |
| 11 | + ) |
| 12 | + password: Optional[str] = Field( |
| 13 | + default=None, |
| 14 | + description="The password for authentication.", |
| 15 | + examples=["<password>", "<user-password>", None], |
| 16 | + ) |
| 17 | + protocol: Literal["SFTP", "FTP", "FTPS"] = Field( |
| 18 | + description="The protocol used for the connection.", |
| 19 | + examples=["SFTP", "FTPS", "FTP"], |
| 20 | + ) |
| 21 | + server_id: str = Field( |
| 22 | + ..., |
| 23 | + alias="serverId", |
| 24 | + description="The server ID of the Transfer Family server.", |
| 25 | + examples=["s-abcd123456", "s-1234567890abcdef0", "s-example123"], |
| 26 | + ) |
| 27 | + source_ip: IPvAnyAddress = Field( |
| 28 | + ..., |
| 29 | + alias="sourceIp", |
| 30 | + description="The IP address of the client connecting to the Transfer Family server.", |
| 31 | + ) |
0 commit comments