mirror of
https://github.com/we-promise/sure.git
synced 2026-05-07 21:04:12 +00:00
feat(api): expose family settings (#1645)
* feat(api): expose family settings * test(api): assert family settings moniker * test(api): align family settings api key helper * fix(api): tighten family settings schema
This commit is contained in:
@@ -401,6 +401,65 @@ components:
|
||||
"$ref": "#/components/schemas/AccountDetail"
|
||||
pagination:
|
||||
"$ref": "#/components/schemas/Pagination"
|
||||
FamilySettings:
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- currency
|
||||
- locale
|
||||
- date_format
|
||||
- month_start_day
|
||||
- moniker
|
||||
- default_account_sharing
|
||||
- custom_enabled_currencies
|
||||
- enabled_currencies
|
||||
- created_at
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
format: uuid
|
||||
name:
|
||||
type: string
|
||||
nullable: true
|
||||
currency:
|
||||
type: string
|
||||
locale:
|
||||
type: string
|
||||
date_format:
|
||||
type: string
|
||||
country:
|
||||
type: string
|
||||
nullable: true
|
||||
timezone:
|
||||
type: string
|
||||
nullable: true
|
||||
month_start_day:
|
||||
type: integer
|
||||
minimum: 1
|
||||
maximum: 28
|
||||
moniker:
|
||||
type: string
|
||||
enum:
|
||||
- Family
|
||||
- Group
|
||||
default_account_sharing:
|
||||
type: string
|
||||
enum:
|
||||
- shared
|
||||
- private
|
||||
custom_enabled_currencies:
|
||||
type: boolean
|
||||
enabled_currencies:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
Category:
|
||||
type: object
|
||||
required:
|
||||
@@ -2488,6 +2547,33 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
"$ref": "#/components/schemas/ErrorResponse"
|
||||
"/api/v1/family_settings":
|
||||
get:
|
||||
summary: Retrieve family settings
|
||||
description: Retrieve a read-only snapshot of non-secret family configuration.
|
||||
tags:
|
||||
- Family Settings
|
||||
security:
|
||||
- apiKeyAuth: []
|
||||
responses:
|
||||
'200':
|
||||
description: family settings retrieved
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
"$ref": "#/components/schemas/FamilySettings"
|
||||
'401':
|
||||
description: unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
"$ref": "#/components/schemas/ErrorResponse"
|
||||
'403':
|
||||
description: insufficient scope
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
"$ref": "#/components/schemas/ErrorResponse"
|
||||
"/api/v1/holdings":
|
||||
get:
|
||||
summary: List holdings
|
||||
|
||||
Reference in New Issue
Block a user