Skip to content
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

Jump to bottom

docs: replace <br> tags with newlines #68

Merged
merged 1 commit into from
Dec 18, 2023
Merged

docs: replace <br> tags with newlines #68

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
14 changes: 10 additions & 4 deletions account.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,11 @@ type Introspection struct {
ClientType IntrospectionClientType `json:"client_type,required"`
// The Finch uuid of the company associated with the `access_token`.
CompanyID string `json:"company_id,required"`
// The type of the connection associated with the token.<br> `provider` -
// connection to an external provider<br> `finch` - finch-generated data.
// The type of the connection associated with the token.
//
// `provider` - connection to an external provider
//
// `finch` - finch-generated data.
ConnectionType IntrospectionConnectionType `json:"connection_type,required"`
// Whether the connection associated with the `access_token` uses the Assisted
// Connect Flow. (`true` if using Assisted Connect, `false` if connection is
Expand Down Expand Up @@ -117,8 +120,11 @@ const (
IntrospectionClientTypeSandbox IntrospectionClientType = "sandbox"
)

// The type of the connection associated with the token.<br> `provider` -
// connection to an external provider<br> `finch` - finch-generated data.
// The type of the connection associated with the token.
//
// `provider` - connection to an external provider
//
// `finch` - finch-generated data.
type IntrospectionConnectionType string

const (
Expand Down
9 changes: 6 additions & 3 deletions aliases.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ import (

type Error = apierror.Error

// - `supported`: This operation is supported by both the provider and Finch <br>
// - `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 <br>
// supported by the provider
//
// - `not_supported_by_provider`: This operation is not supported by the provider,
// so Finch cannot support <br>
// so Finch cannot support
//
// - `client_access_only`: This behavior is supported by the provider, but only
// available to the client and not to Finch
//
Expand Down
45 changes: 30 additions & 15 deletions internal/shared/shared.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@ import (
"github.com/Finch-API/finch-api-go/internal/apijson"
)

// - `supported`: This operation is supported by both the provider and Finch <br>
// - `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 <br>
// supported by the provider
//
// - `not_supported_by_provider`: This operation is not supported by the provider,
// so Finch cannot support <br>
// so Finch cannot support
//
// - `client_access_only`: This behavior is supported by the provider, but only
// available to the client and not to Finch
type OperationSupport string
Expand All @@ -23,35 +26,47 @@ const (
)

type OperationSupportMatrix struct {
// - `supported`: This operation is supported by both the provider and Finch <br>
// - `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 <br>
// supported by the provider
//
// - `not_supported_by_provider`: This operation is not supported by the provider,
// so Finch cannot support <br>
// so Finch cannot support
//
// - `client_access_only`: This behavior is supported by the provider, but only
// available to the client and not to Finch
Create OperationSupport `json:"create"`
// - `supported`: This operation is supported by both the provider and Finch <br>
// - `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 <br>
// supported by the provider
//
// - `not_supported_by_provider`: This operation is not supported by the provider,
// so Finch cannot support <br>
// 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 OperationSupport `json:"delete"`
// - `supported`: This operation is supported by both the provider and Finch <br>
// - `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 <br>
// supported by the provider
//
// - `not_supported_by_provider`: This operation is not supported by the provider,
// so Finch cannot support <br>
// 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 OperationSupport `json:"read"`
// - `supported`: This operation is supported by both the provider and Finch <br>
// - `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 <br>
// supported by the provider
//
// - `not_supported_by_provider`: This operation is not supported by the provider,
// so Finch cannot support <br>
// 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 OperationSupport `json:"update"`
Expand Down