Feat: add CGW Accounts API specification #190
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| export type Account = { | ||
| accountId: string | ||
| groupId: string | null | ||
| address: string | ||
| } | ||
|
|
||
| export type AccountDataType = { | ||
| id: string | ||
| name: string | ||
| description: string | null | ||
| isActive: boolean | ||
| } | ||
|
|
||
| export type AccountDataSetting = { | ||
| name: string | ||
| description: string | null | ||
| enabled: boolean | ||
| } | ||
|
|
||
| export type CreateAccountDto = { | ||
|
There was a problem hiding this comment. Please don't use the DTO acronym in type names. It makes sense within the internal CGW architecture, but for clients it's a non-concept. |
||
| address: string | ||
| } | ||
|
|
||
| export type UpsertAccountDataSettingsDto = { | ||
| accountDataSettings: { | ||
| id: string | ||
| enabled: boolean | ||
|
There was a problem hiding this comment. Another (partial) duplication of There was a problem hiding this comment. Also solved in eaa943b |
||
| }[] | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,6 +46,13 @@ import type { RelayCountResponse, RelayTransactionRequest, RelayTransactionRespo | |
| import type { RegisterRecoveryModuleRequestBody } from './recovery' | ||
| import type { Contract } from './contracts' | ||
| import type { AuthNonce } from './auth' | ||
| import { | ||
| Account, | ||
| AccountDataSetting, | ||
| AccountDataType, | ||
| CreateAccountDto, | ||
| UpsertAccountDataSettingsDto, | ||
| } from './accounts' | ||
hectorgomezv marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| export type Primitive = string | number | boolean | null | ||
|
|
||
|
|
@@ -472,6 +479,39 @@ export interface paths extends PathRegistry { | |
| } | ||
| } | ||
| } | ||
| '/v1/accounts': { | ||
| post: operations['create_account'] | ||
| parameters: { | ||
| path: null | ||
| credentials: 'include' | ||
| } | ||
| } | ||
| '/v1/accounts/{address}': { | ||
| get: operations['get_account'] | ||
| delete: operations['delete_account'] | ||
| parameters: { | ||
| path: { | ||
| address: string | ||
| } | ||
| credentials: 'include' | ||
| } | ||
| } | ||
| '/v1/accounts/data-types': { | ||
| get: operations['get_account_data_types'] | ||
| parameters: { | ||
| path: null | ||
| } | ||
| } | ||
| '/v1/accounts/{address}/data-settings': { | ||
| get: operations['get_account_data_settings'] | ||
| put: operations['put_account_data_settings'] | ||
| parameters: { | ||
| path: { | ||
| address: string | ||
| } | ||
| credentials: 'include' | ||
| } | ||
| } | ||
usame-algan marked this conversation as resolved.
Show resolved
Hide resolved
Comment on lines
+505
to
+514
There was a problem hiding this comment. Not sure if we have to define the body here as well but when calling |
||
| } | ||
|
|
||
| export interface operations { | ||
|
|
@@ -1225,4 +1265,82 @@ export interface operations { | |
| } | ||
| } | ||
| } | ||
| create_account: { | ||
| parameters: { | ||
| body: CreateAccountDto | ||
hectorgomezv marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| credentials: 'include' | ||
| } | ||
| responses: { | ||
| 200: { | ||
| schema: Account | ||
| } | ||
| 403: unknown | ||
| 422: unknown | ||
| } | ||
| } | ||
| get_account_data_types: { | ||
| parameters: null | ||
| responses: { | ||
| 200: { | ||
| schema: AccountDataType[] | ||
| } | ||
| } | ||
| } | ||
| get_account_data_settings: { | ||
| parameters: { | ||
| path: { | ||
| address: string | ||
| } | ||
| credentials: 'include' | ||
| } | ||
| responses: { | ||
| 200: { | ||
| schema: AccountDataSetting[] | ||
| } | ||
| 403: unknown | ||
| } | ||
| } | ||
| put_account_data_settings: { | ||
| parameters: { | ||
| path: { | ||
| address: string | ||
| } | ||
| credentials: 'include' | ||
| body: UpsertAccountDataSettingsDto | ||
hectorgomezv marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| responses: { | ||
| 200: { | ||
| schema: AccountDataSetting[] | ||
| } | ||
| 403: unknown | ||
| } | ||
| } | ||
| get_account: { | ||
| parameters: { | ||
| path: { | ||
| address: string | ||
| } | ||
| credentials: 'include' | ||
| } | ||
| responses: { | ||
| 200: { | ||
| schema: Account | ||
| } | ||
| 403: unknown | ||
| } | ||
| } | ||
| delete_account: { | ||
| parameters: { | ||
| path: { | ||
| address: string | ||
| } | ||
| credentials: 'include' | ||
| } | ||
| responses: { | ||
| 204: { | ||
| schema: void | ||
| } | ||
| 403: unknown | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There seems to be an overlap here. Can we combine this into a shared type?
Also is
isActiveandenabledthe same thing?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
isActiveis an AccountDataType-only property. It indicates if the DataType (CF Safes, watchlist, etc.) is generally available in the CGW. The idea behind this is to provide a list of available DataTypes so the UI could build the list of checkboxes (or another widget) for the user to select using this as a source of truth. An alternative approach would be to use thisisActiveinternally in the CGW and only return the active ones to the UI. This would be simpler but also less transparent. Do you have any preference regarding this? 🙂enabledis an AccountDataSetting-only property. It represents a specific user setting (i.e.: whether the checkbox is marked or it isn't)Regarding the overlap you commented on, I think you are right and this API can also be simplified. I'm working in the CGW on that regard and will update this accordingly later on 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've modified the API on the CGW side, and I have also modified this PR accordingly in eaa943b
Account.accountIdwas renamed to simplyid(as it's the type main identifier).AccountDataTypeandAccountDataSettingtypes.