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.

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

Documentaçao do endpoint de consultar redes sociais do usuário #50

Merged
merged 5 commits into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
description: Successful retrieval of user social networks
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
description: The user ID (UUID).
example: 'd215f543-f05c-40c2-a665-1a98f108bb5c'
avatarUrl:
type: string
description: URL for the user's avatar image.
example: 'https://backend/files/image.png'
socialMedia:
type: object
properties:
id:
type: integer
description: The ID of the social media platform.
example: 1
name:
type: string
description: The name of the social media platform.
example: 'Facebook'
required:
- id
- avatarUrl
- socialMedia
15 changes: 15 additions & 0 deletions openapi/features/user/user-network-find-all.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
get:
operationId: consultUserAccounts
summary: Consult user social networks
description: Retrieves information about the social networks associated with a user.
tags:
- user

responses:
'200':
$ref: './components/user-network-find-all-body.yaml'
'400':
$ref: '../../shared/errors/validation-error.yaml'
'500':
$ref: '../../shared/errors/server-error.yaml'

3 changes: 3 additions & 0 deletions openapi/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,6 @@ tags:
paths:
/user/create:
$ref: './features/user/user-create-path.yaml'

/users/:id/accounts:
$ref: './features/user/user-network-find-all.yaml'
Loading