Skip to content

Commit

Permalink
ACS-9023 Implement PUT method for Preferences API (#219)
Browse files Browse the repository at this point in the history
* ACS-9023 Add endpoint to update a preference

* ACS-9023 Add 400 code
  • Loading branch information
damianujma authored Dec 10, 2024
1 parent f186c83 commit e80f180
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions src/main/webapp/definitions/alfresco-core.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5456,6 +5456,50 @@ paths:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
put:
tags:
- preferences
summary: Update a preference
description: |
Updates a specific preference for person **personId**.
You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
operationId: updatePreference
produces:
- application/json
parameters:
- $ref: '#/parameters/personIdParam'
- name: preferenceName
in: path
description: The name of the preference.
required: true
type: string
- $ref: '#/parameters/fieldsParam'
- in: body
name: preferenceBodyUpdate
description: The preference information to update.
required: true
schema:
$ref: '#/definitions/PreferenceBodyUpdate'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/PreferenceEntry'
'401':
description: Authentication failed
'400':
description: |
Invalid parameter: **preferenceBodyUpdate** is invalid
'403':
description: Current user does not have access to the preferences for **personId**
'404':
description: |
**personId** or **preferenceName** does not exist
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
'/people/{personId}/site-membership-requests':
get:
tags:
Expand Down Expand Up @@ -10252,6 +10296,17 @@ definitions:
value:
type: string
description: The value of the preference. Note that this can be of any JSON type.
PreferenceBodyUpdate:
type: object
required:
- id
properties:
id:
type: string
description: The unique id of the preference
value:
type: string
description: The value of the preference. Note that this can be of any JSON type.
SiteMembershipRequestBodyCreate:
type: object
required:
Expand Down

0 comments on commit e80f180

Please sign in to comment.