Skip to content
Snippets Groups Projects

adding my profile route + basic my profile page

Merged Eloi Juszczak requested to merge profile into master
9 files
+ 313
218
Compare changes
  • Side-by-side
  • Inline
Files
9
+ 145
146
@@ -13,28 +13,28 @@ externalDocs:
description: Find out more about Swagger
url: http://swagger.io
servers:
- url: https://virtserver.swaggerhub.com/Sr05-Project/Distributed_Facebook_API/1.0.0
description: SwaggerHub API Auto Mocking
- url: https://virtserver.swaggerhub.com/Sr05-Project/Receive/1.0.0
- url: http://virtserver.swaggerhub.com/Sr05-Project/Receive/1.0.0
- url: https://virtserver.swaggerhub.com/Sr05-Project/Distributed_Facebook_API/1.0.0
description: SwaggerHub API Auto Mocking
- url: https://virtserver.swaggerhub.com/Sr05-Project/Receive/1.0.0
- url: http://virtserver.swaggerhub.com/Sr05-Project/Receive/1.0.0
tags:
- name: communication
description: communication request
externalDocs:
description: Find out more
url: http://swagger.io
- name: friends
description: Access to friend's friends
- name: posts
description: Operations about posts
externalDocs:
description: Find out more about our posts lul
url: http://swagger.io
- name: communication
description: communication request
externalDocs:
description: Find out more
url: http://swagger.io
- name: friends
description: Access to friend's friends
- name: posts
description: Operations about posts
externalDocs:
description: Find out more about our posts lul
url: http://swagger.io
paths:
/init:
get:
tags:
- Local
- Local
summary: Target by the local react on start
description: Ask if friends are available and ask for the snapshot
operationId: init
@@ -45,11 +45,11 @@ paths:
/communicate:
post:
tags:
- communication
- communication
summary: Treat this message
operationId: receiveMessage
requestBody:
$ref: '#/components/requestBodies/Message'
$ref: "#/components/requestBodies/Message"
responses:
"405":
description: Invalid
@@ -57,7 +57,7 @@ paths:
/receiveMessage:
post:
tags:
- communication
- communication
summary: add a new message
operationId: receiveMessagePOST
responses:
@@ -70,7 +70,7 @@ paths:
/sendMessageFriend:
post:
tags:
- communication
- communication
summary: add a new message to your friend
operationId: sendMessagePOST
responses:
@@ -83,29 +83,29 @@ paths:
/getAllPublicMessages:
get:
tags:
- communication
- communication
summary: get all new message of everyone reachable
operationId: sendPublicMessagePOST
parameters:
- name: visited
in: query
description: Sites that have already been visited
required: true
allowEmptyValue: true
style: form
explode: true
schema:
type: array
items:
- name: visited
in: query
description: Sites that have already been visited
required: true
allowEmptyValue: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: origin
in: query
description: origin of the request
required: true
style: form
explode: true
schema:
type: string
- name: origin
in: query
description: origin of the request
required: true
style: form
explode: true
schema:
type: string
responses:
"200":
description: OK
@@ -116,19 +116,19 @@ paths:
/privateMessages:
get:
tags:
- communication
- communication
summary: Getmessages from user
description: Get messages from receiving user
operationId: privateMessagesofUserGET
parameters:
- name: url
in: query
description: url of user
required: true
style: form
explode: true
schema:
type: string
- name: url
in: query
description: url of user
required: true
style: form
explode: true
schema:
type: string
responses:
"200":
description: successful operation
@@ -137,18 +137,18 @@ paths:
schema:
type: array
items:
$ref: '#/components/schemas/Message'
$ref: "#/components/schemas/Message"
x-content-type: application/json
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Message'
$ref: "#/components/schemas/Message"
x-swagger-router-controller: Communication
/publicMessages:
get:
tags:
- communication
- communication
summary: Get public messages from user
description: Get public messages from an user
operationId: publicMessagesofUserGET
@@ -160,18 +160,18 @@ paths:
schema:
type: array
items:
$ref: '#/components/schemas/Message'
$ref: "#/components/schemas/Message"
x-content-type: application/json
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Message'
$ref: "#/components/schemas/Message"
x-swagger-router-controller: Communication
/friends:
get:
tags:
- friends
- friends
summary: Get friends from receiving user
description: Get friends from receiving user
operationId: getAllFriends
@@ -183,31 +183,31 @@ paths:
schema:
type: array
items:
$ref: '#/components/schemas/Friends'
$ref: "#/components/schemas/Friends"
x-content-type: application/json
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Friends'
$ref: "#/components/schemas/Friends"
x-swagger-router-controller: Friends
post:
tags:
- friends
- friends
summary: Add me as friend
operationId: addMe
parameters:
- name: situation
in: query
description: inner request or out request
required: true
style: form
explode: true
schema:
type: string
enum:
- out
- in
- name: situation
in: query
description: inner request or out request
required: true
style: form
explode: true
schema:
type: string
enum:
- out
- in
responses:
"200":
description: request has been made
@@ -222,61 +222,60 @@ paths:
/notify:
get:
tags:
- friends
- friends
summary: Notify the the targeted user than you are connected
description: Say that you are connected
operationId: notify
parameters:
- name: from
in: query
description: origin of the request
required: true
style: form
explode: true
schema:
type: integer
- name: action
in: query
description: type of notification
required: true
style: form
explode: true
schema:
type: string
enum:
- login
- logout
responses:
"200":
description: returned if you are connected
x-swagger-router-controller: Friends
/me:
get:
tags:
- friends
summary: Get the friend that correspond to the current node user
description: Retrieve me.
operationId: me
responses:
"200":
description: returned if you are connected
content:
application/json:
schema:
$ref: "#/components/schemas/User"
x-content-type: application/json
application/xml:
schema:
$ref: "#/components/schemas/Friends"
x-swagger-router-controller: Friends
/getFeed:
get:
tags:
- posts
- posts
summary: Get the feed of someone
description: Feed getter
operationId: getFeed
parameters:
- name: visited
in: query
description: Sites that have already been visited
required: true
allowEmptyValue: true
style: form
explode: true
schema:
type: array
items:
- name: visited
in: query
description: Sites that have already been visited
required: true
allowEmptyValue: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: origin
in: query
description: origin of the request
required: true
style: form
explode: true
schema:
type: string
- name: origin
in: query
description: origin of the request
required: true
style: form
explode: true
schema:
type: string
responses:
"200":
description: successful operation
@@ -285,30 +284,30 @@ paths:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
$ref: "#/components/schemas/Post"
x-content-type: application/json
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
$ref: "#/components/schemas/Post"
x-swagger-router-controller: Posts
/posts:
get:
tags:
- posts
- posts
summary: Get posts from friend
description: Get posts from friend
operationId: getAllPosts
parameters:
- name: status
in: query
description: Status values that need to be considered for filter
required: false
style: form
explode: true
schema:
$ref: '#/components/schemas/User'
- name: status
in: query
description: Status values that need to be considered for filter
required: false
style: form
explode: true
schema:
$ref: "#/components/schemas/User"
responses:
"200":
description: successful operation
@@ -317,17 +316,17 @@ paths:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
$ref: "#/components/schemas/Post"
x-content-type: application/json
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
$ref: "#/components/schemas/Post"
x-swagger-router-controller: Posts
post:
tags:
- posts
- posts
summary: Create a new post
operationId: createNewPost
responses:
@@ -346,27 +345,27 @@ components:
Friends:
type: array
items:
$ref: '#/components/schemas/User'
$ref: "#/components/schemas/User"
Message:
required:
- content
- messageType
- sender
- target
- content
- messageType
- sender
- target
type: object
properties:
id:
type: integer
format: int64
messageType:
$ref: '#/components/schemas/MessageType'
$ref: "#/components/schemas/MessageType"
content:
type: string
example: Salut
sender:
$ref: '#/components/schemas/User'
$ref: "#/components/schemas/User"
target:
$ref: '#/components/schemas/User'
$ref: "#/components/schemas/User"
example:
messageType: private
sender:
@@ -379,7 +378,7 @@ components:
name: Pet
CreateNewPost:
required:
- content
- content
type: object
properties:
content:
@@ -396,12 +395,12 @@ components:
MessageType:
type: string
enum:
- private
- broadcast
- private
- broadcast
User:
required:
- name
- url
- name
- url
type: object
properties:
id:
@@ -417,10 +416,10 @@ components:
url: url
Post:
required:
- author
- content
- date
- id
- author
- content
- date
- id
type: object
properties:
id:
@@ -431,7 +430,7 @@ components:
content:
type: string
author:
$ref: '#/components/schemas/User'
$ref: "#/components/schemas/User"
example:
date: date
author:
@@ -448,25 +447,25 @@ components:
schema:
type: array
items:
$ref: '#/components/schemas/User'
$ref: "#/components/schemas/User"
required: true
Message:
description: message to process
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
$ref: "#/components/schemas/Message"
application/xml:
schema:
$ref: '#/components/schemas/Message'
$ref: "#/components/schemas/Message"
required: true
CreateNewPost:
description: Post to create
content:
application/json:
schema:
$ref: '#/components/schemas/CreateNewPost'
$ref: "#/components/schemas/CreateNewPost"
application/xml:
schema:
$ref: '#/components/schemas/CreateNewPost'
$ref: "#/components/schemas/CreateNewPost"
required: true
Loading