Skip to content

chore(api): improve descriptions #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2024
Merged

chore(api): improve descriptions #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions src/finch/types/introspection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,8 @@ class Introspection(BaseModel):
connection_type: Literal["provider", "finch"]
"""The type of the connection associated with the token.

`provider` - connection to an external provider

`finch` - finch-generated data.
- `provider` - connection to an external provider
- `finch` - finch-generated data.
"""

manual: bool
Expand Down
24 changes: 8 additions & 16 deletions src/finch/types/shared/operation_support_matrix.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,53 +10,45 @@

class OperationSupportMatrix(BaseModel):
create: Optional[OperationSupport] = None
"""- `supported`: This operation is supported by both the provider and Finch

"""
- `supported`: This operation is supported by both the provider and Finch
- `not_supported_by_finch`: This operation is not supported by Finch but
supported by the provider

- `not_supported_by_provider`: This operation is not supported by the provider,
so Finch cannot support

- `client_access_only`: This behavior is supported by the provider, but only
available to the client and not to Finch
"""

delete: Optional[OperationSupport] = None
"""- `supported`: This operation is supported by both the provider and Finch

"""
- `supported`: This operation is supported by both the provider and Finch
- `not_supported_by_finch`: This operation is not supported by Finch but
supported by the provider

- `not_supported_by_provider`: This operation is not supported by the provider,
so Finch cannot support

- `client_access_only`: This behavior is supported by the provider, but only
available to the client and not to Finch
"""

read: Optional[OperationSupport] = None
"""- `supported`: This operation is supported by both the provider and Finch

"""
- `supported`: This operation is supported by both the provider and Finch
- `not_supported_by_finch`: This operation is not supported by Finch but
supported by the provider

- `not_supported_by_provider`: This operation is not supported by the provider,
so Finch cannot support

- `client_access_only`: This behavior is supported by the provider, but only
available to the client and not to Finch
"""

update: Optional[OperationSupport] = None
"""- `supported`: This operation is supported by both the provider and Finch

"""
- `supported`: This operation is supported by both the provider and Finch
- `not_supported_by_finch`: This operation is not supported by Finch but
supported by the provider

- `not_supported_by_provider`: This operation is not supported by the provider,
so Finch cannot support

- `client_access_only`: This behavior is supported by the provider, but only
available to the client and not to Finch
"""