Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-13 13:54:23 +00:00
Code Issues Actions Projects Releases Wiki Activity

household address: add swagger documentation

Browse Source
This commit is contained in:
nobohan 2021-06-08 08:55:41 +02:00
parent 9d32ccbcad
commit 66b54bad31
1 changed files with 77 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
src/Bundle/ChillPersonBundle/chill.api.specs.yaml
View File

@ -784,6 +784,41 @@ paths:
400: 400:
description: "transition cannot be applyed" description: "transition cannot be applyed"
/1.0/person/household.json:
get:
tags:
- household
summary: Return a list of all household
responses:
200:
description: "ok"
/1.0/person/household/{id}.json:
get:
tags:
- household
summary: Return a household by id
parameters:
- name: id
in: path
required: true
description: The household id
schema:
type: integer
format: integer
minimum: 1
responses:
200:
description: "ok"
content:
application/json:
schema:
$ref: '#/components/schemas/Household'
404:
description: "not found"
401:
description: "Unauthorized"
/1.0/person/household/members/move.json: /1.0/person/household/members/move.json:
post: post:
tags: tags:
@ -826,3 +861,38 @@ paths:
400: 400:
description: "transition cannot be applyed" description: "transition cannot be applyed"
/1.0/person/household/{id}/address.json:
post:
tags:
- household
summary: post an address to a household
parameters:
- name: id
in: path
required: true
description: The household id
schema:
type: integer
format: integer
minimum: 1
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: The address id to attach to the household
responses:
401:
description: "Unauthorized"
404:
description: "Not found"
200:
description: "OK"
422:
description: "Unprocessable entity (validation errors)"
400:
description: "transition cannot be applyed"