{"info":{"_postman_id":"15b3891c-6813-4cc1-8a99-3bd471227942","name":"Sport Compass Blog - Public","description":"

Sport Compass.

Backend Assingment.

This documentation only will cover the Blog API.

Git Repository https://github.com/realFranco/backend_assignment_sc

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6474278","collectionId":"15b3891c-6813-4cc1-8a99-3bd471227942","publishedId":"SzmZdLMZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-05-02T16:01:37.000Z"},"item":[{"name":"Post","item":[{"name":"Create Post","id":"79983a74-ebc6-4551-93eb-daeef49062c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"cover_img","type":"file","src":"/home/diuble-lig/Pictures/posgresql_stuff.png"}]},"url":"http://localhost:7000/post?user_name=Franco&user_last_n=Gil&post_title=Post1&post_text=New Era.","description":"

Create a post using a set of params as resources.

\n
\n\n

Params:

user_name: Name from the Post creator.
user_last_n: Last name from the Post creator.
post_title: Title that will conserve the post, the title need to be unique.
post_text: Content of the post, will no render special characters, markdown syntax, italic, black fonts etc, just \"raw text\".

\n
\n\n

Body:

cover_img: [Optional] Image passed to the endpint (before approve, check the extension of the file)

\n","urlObject":{"protocol":"http","port":"7000","path":["post"],"host":["localhost"],"query":[{"key":"user_name","value":"Franco"},{"key":"user_last_n","value":"Gil"},{"key":"post_title","value":"Post1"},{"key":"post_text","value":"New Era."}],"variable":[]}},"response":[],"_postman_id":"79983a74-ebc6-4551-93eb-daeef49062c0"},{"name":"View Post","id":"44462175-e353-411c-8b77-00d3460ace79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:7000/post/Post1","description":"

Return the resources of a post. Post info., user info.\n

To trigger the endpoint:\n

GET /post/{id_title}

\n
\n\n

Note: The title of the post may contain spaces and special characters.\nConserve the set of special characters to make a correct query.

\n","urlObject":{"protocol":"http","port":"7000","path":["post","Post1"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"44462175-e353-411c-8b77-00d3460ace79"},{"name":"Scan Post","id":"ed1622f0-592f-432f-8071-08715f5d65d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:7000/post/","description":"

Return all posts and all the resources from every post.\n
\n
\nNote: No exist order over the way of send the content and\nno exist paggination on the results, this is a complete\nscan of the tables.

\n","urlObject":{"protocol":"http","port":"7000","path":["post",""],"host":["localhost"],"query":[{"disabled":true,"key":"limit","value":"0"}],"variable":[]}},"response":[],"_postman_id":"ed1622f0-592f-432f-8071-08715f5d65d9"},{"name":"Edit Post","event":[{"listen":"test","script":{"id":"abfbc24e-2161-4e24-b43a-8f96f259ced6","exec":[""],"type":"text/javascript"}}],"id":"515c79cf-0c09-4083-a4d9-91f22e9b36a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"cover_img","type":"file","src":"/home/diuble-lig/Pictures/yoka_en_boss_landia.jpg"}]},"url":"http://localhost:7000/post/te?title=t2&text=post edited&avaliable=true","description":"

Edit a post.\n
\n

To trigger the endpoint: \n
\nPUT /post/{title}\n
\n

Params:

title: [Optional] New title of the post, need to ba another distinct.
text: [Optional] New content of the post.
avaliable: [Optional] The creator can also hide this post.

\n","urlObject":{"protocol":"http","port":"7000","path":["post","te"],"host":["localhost"],"query":[{"key":"title","value":"t2"},{"key":"text","value":"post edited"},{"description":{"content":"

boolean

\n","type":"text/plain"},"key":"avaliable","value":"true"}],"variable":[]}},"response":[],"_postman_id":"515c79cf-0c09-4083-a4d9-91f22e9b36a0"},{"name":"Delete Post","id":"564940e6-81d8-49b1-b4f0-08d4e7d398f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:7000/post/Post1","description":"

Given title from the post, delete the Post and the \nresources asociated to him (commentary and user creator)\n
\n

To trigger the endpoint:\n
\nDELETE post/{id_title}\n
\n

Params:

id_post [Not Optional]

\n","urlObject":{"protocol":"http","port":"7000","path":["post","Post1"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"564940e6-81d8-49b1-b4f0-08d4e7d398f2"},{"name":"Delet All Posts","id":"b73f5e39-cb7c-44f8-936a-2b8c766ea1ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:7000/post/","description":"

Delete all the post and the resources contained by every post.

\n","urlObject":{"protocol":"http","port":"7000","path":["post",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"b73f5e39-cb7c-44f8-936a-2b8c766ea1ff"}],"id":"0194908a-5531-4430-b45a-9c1a06ca0478","description":"

Set of endpoints that control the Post data.

\n","event":[{"listen":"prerequest","script":{"id":"55ea4f5e-797b-4f96-8091-45528b4cac8d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a1d9170d-4a9e-4d32-9940-5c879e7878c0","type":"text/javascript","exec":[""]}}],"_postman_id":"0194908a-5531-4430-b45a-9c1a06ca0478"},{"name":"Commentary","item":[{"name":"Create Commentary","id":"9ef57456-2523-4714-ab30-762dd783f762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:7000/commentary?post_title=ff&comm_text=New content&user_name=commentor","description":"

Given 3 params. create commentary over a post.\n
\n

Params:\n

id_user: [Optional] user who make the post
id_post: post where the commentary will be placed
user_name: [Optional] If id_user it is not defined, pass a name from an user and will be creadted a new one.
text: content of the commentary

\n","urlObject":{"protocol":"http","port":"7000","path":["commentary"],"host":["localhost"],"query":[{"disabled":true,"key":"id_user","value":""},{"key":"post_title","value":"ff"},{"key":"comm_text","value":"New content"},{"key":"user_name","value":"commentor"}],"variable":[]}},"response":[],"_postman_id":"9ef57456-2523-4714-ab30-762dd783f762"},{"name":"Edit Commentary","id":"cb5f9277-d9fd-416a-bc13-0dada28fe9b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"http://localhost:7000/commentary?id_comentary=ee90597a-5c1b-452d-b56f-d29002164616&text=renew the commentary","description":"

Edit a commentary.\n

Params:

id_comentary: Identificator from the commentary (uuid data type).
text: New content from the commentary.

\n","urlObject":{"protocol":"http","port":"7000","path":["commentary"],"host":["localhost"],"query":[{"key":"id_comentary","value":"ee90597a-5c1b-452d-b56f-d29002164616"},{"key":"text","value":"renew the commentary"}],"variable":[]}},"response":[],"_postman_id":"cb5f9277-d9fd-416a-bc13-0dada28fe9b1"},{"name":"Delete Commentary","id":"7f5aa4f4-8eeb-442f-a757-04fc1950d5eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:7000/commentary?id_post=e87c33ac-e50f-422a-a9a8-3f99d363451c","description":"

Delete 1 or a set of comments from a post

params:

id_post: [Optional] if passed to the call, delete all the comments avalaible for that post.
id_comentary: [Optional] if passed to the call, delete a commentary with this specific id.

\n","urlObject":{"protocol":"http","port":"7000","path":["commentary"],"host":["localhost"],"query":[{"disabled":true,"key":"id_comentary","value":"e4efa47c-84fe-47b4-9b6d-5394fdfdb8c9"},{"key":"id_post","value":"e87c33ac-e50f-422a-a9a8-3f99d363451c"}],"variable":[]}},"response":[],"_postman_id":"7f5aa4f4-8eeb-442f-a757-04fc1950d5eb"}],"id":"0749dc1f-1a8c-4a9e-8b39-ae7235870c64","description":"

Set of endpoints controllers for the commentary data management.

\n","event":[{"listen":"prerequest","script":{"id":"5a1f2dd1-ae30-4e26-90ea-0d3681808bfa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dd6c3926-e64b-4a8b-a702-eca6ed38a515","type":"text/javascript","exec":[""]}}],"_postman_id":"0749dc1f-1a8c-4a9e-8b39-ae7235870c64"}],"event":[{"listen":"prerequest","script":{"id":"f0d925f9-5aa4-42e7-9ebe-354c3494ed24","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cb2dfef5-21e5-4300-8435-17f0ad05e375","type":"text/javascript","exec":["sc_c0mments_and_p0st"]}}]}