Giter Club home page Giter Club logo

tdos's Introduction

TDoS

Description of endpoints:

Generic user obtain data

GET : /users

Obtains the data of all the users

GET : /user?userName=

Obtains the data given an userName

GET : /userbyId?id=

Obtains the data given an id of an user

GET : /twoUsers?userName=&friendName

Obtains the data of two specific users

For user register, validation and changes

GET : /users/validate-token

A session token in the headers is neeeded. Validates a session token.

POST: /users/login

Needs a body with the userName and the userPassword. Generates a session token if the user exists.

POST: /users/register

Needs a body with the userName and the userPassword. Registers an user

POST: /users/changePassword

Needs a body with the userName and the userPassword. Changes the password of an user

Endpoints for friend managment and summaty managment

GET: /notFriends?userName=

Returns all the users that are not yet friends of the user that has the given userName

GET: /pendingFriends?userName=

Returns all the users that are pending friends of the user that has the given userName

GET: /acceptedFriends?userName=

Returns all the users that are accepted friends of the user that has the given userName

POST: /userFriend?userName=&friendName=

Generates a friend request. Generates friend status of pending

PATCH: /userFriend?userName=&friendName=

Accepts a friend request. Generates friend status of accepted

PATCH: /shareToFriend?userName=&friendName=

Shares summaries between friends

DELETE: /userFriend?userName=&friendName=

Deletes friend and servers any conection to it.

DELETE: /unshareToFriend?userName=&friendName=

Unshares summaries between friends.

POST: /userSummary?userName=&summaryId=

Adds a summaryId to the summaryList of the user

POST: /userSaveSummary?userName=&summaryId=

Saves and creates a copy of a summary from another user.

DELETE: /userSummary?userName=&summaryId=

Deletes a summaryId to the summaryList of the user.

Endpoints mainly for summaries collection

GET : /summaries

Obtains the data of all the summaries

GET : /summaryById?summaryId=

Obtains the summary given an summaryId

GET : /summaryByCreator?creatorId=

Obtains all the summaries of a given user

GET : /summaryFeed?userName=

Obtains the feed of summaries of an users

GET : /summaryPublic

Obtains the feed of summaries that are public

POST : /summary

Needs in the body all information needed in order to generate a summary

DELETE : /summary?summaryId=

Erases a summary

PATCH : /summary?summaryId=

Needs in the body all information needed in order to update a summary

tdos's People

Contributors

thegreatsea avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.