{"swagger":"2.0","info":{"description":"Base API description for 7 PICS","version":"1.0.0","title":"7 PICS"},"schemes":["http"],"tags":[{"name":"user","description":"Operations about user"},{"name":"series","description":"Operations for series"},{"name":"contact","description":"Operations for feedback"},{"name":"categories","description":"Operations for categories"},{"name":"search","description":"Operations for search"},{"name":"desktops","description":"Operations with desktops"},{"name":"desktops-view","description":"Operations with desktops view"}],"paths":{"/register":{"post":{"tags":["user"],"summary":"Registers user into the system","operationId":"registerUser","description":"Registers user into the system","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"registerUser","description":"User to add","schema":{"$ref":"#/definitions/RegisterUser"}}],"responses":{"204":{"description":"successful operation"},"400":{"description":"Email is already exists or password is too simple"}}}},"/login":{"post":{"tags":["user"],"summary":"authorize user into the system","operationId":"loginUser","description":"Authorize user into the system by login and password","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"loggedUser","description":"User to authorize","schema":{"$ref":"#/definitions/LoggedUser"}}],"responses":{"200":{"description":"JWT token","schema":{"type":"string"}},"400":{"description":"Invalid username/password supplied"}}}},"/forgot-password":{"post":{"tags":["user"],"summary":"send request to reset password by user's email","description":"Send user email to reset password","operationId":"forgotPassword","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"forgotPassword","description":"User's email to reset password","schema":{"$ref":"#/definitions/ForgotPassword"}}],"responses":{"204":{"description":"successful operation"},"400":{"description":"Unexpected error"}}}},"/reset-check-token/{token}":{"get":{"tags":["user"],"summary":"Checks token before to create new password","description":"Checks token from URL before to create new password.","operationId":"checkResetToken","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"token","in":"path","description":"token","required":true,"type":"string"}],"responses":{"204":{"description":"successful operation"},"400":{"description":"invalid token"}}}},"/reset-password":{"put":{"tags":["user"],"summary":"Resets user password","operationId":"resetPassword","description":"Update user password after forgotten password","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"loggedUser","description":"New password and token to update password","schema":{"$ref":"#/definitions/ResetPassword"}}],"responses":{"204":{"description":"successful operation"},"400":{"description":"token invalid or password is too simple"}}}},"/profile":{"get":{"tags":["user"],"summary":"get user profile data","operationId":"getUserProfile","description":"Get user profile data","produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"404":{"description":"User not found"}}},"put":{"tags":["user"],"summary":"update user profile","operationId":"updateUserProfile","description":"This can only be done by the logged in user.","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"User profile","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"400":{"description":"Wrong password"},"409":{"description":"Username or email already exists"}}},"delete":{"tags":["user"],"summary":"delete user profile","operationId":"deleteUserProfile","description":"Delete user profile","responses":{"200":{"description":"OK"}}}},"/series":{"get":{"tags":["series"],"summary":"get series collection","operationId":"getSeries","description":"Get series collection for unauthorized user","produces":["application/json"],"parameters":[{"in":"query","name":"skip","description":"number of records to skip for pagination","type":"integer","format":"int32","required":false,"default":0,"minimum":0},{"in":"query","name":"limit","description":"maximum number of records to return","type":"integer","format":"int32","required":false,"default":10,"minimum":1,"maximum":50}],"responses":{"200":{"description":"series data","schema":{"type":"array","items":{"$ref":"#/definitions/SeriesItem"}}},"400":{"description":"bad input parameter"}}},"post":{"tags":["series"],"summary":"create new series collection","operationId":"createSeries","description":"Create series collection for authorized user","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"seriesNew","description":"New series to add","schema":{"$ref":"#/definitions/SeriesNew"}}],"responses":{"204":{"description":"successful operation"},"400":{"description":"bad input parameter"}}}},"/series/{id}":{"get":{"tags":["series"],"summary":"get details series information","operationId":"getSeriesDetail","description":"Get details for series with id","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"series id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"details series data","schema":{"$ref":"#/definitions/SeriesDetail"}},"400":{"description":"bad input parameter"},"404":{"description":"not found"}}}},"/categories":{"get":{"tags":["categories"],"summary":"get page of categories collection with basic series info included","operationId":"getCategories","description":"Get page of categories collection with basic series info included","produces":["application/json"],"parameters":[{"in":"query","name":"page","description":"page to return for pagination, starting with 0","type":"integer","format":"int32","required":false,"default":0,"minimum":0},{"in":"query","name":"limit","description":"number of records in one page","type":"integer","format":"int32","required":false,"default":10,"minimum":1,"maximum":50},{"in":"query","name":"locale","description":"locale for locale-dependent data (e.g. category name)","type":"string","required":false,"default":"en"}],"responses":{"200":{"description":"categories list single page data","schema":{"$ref":"#/definitions/CategoriesListPage"}},"400":{"description":"bad input parameter"}}}},"/category/{category_id}/series":{"get":{"tags":["series"],"summary":"get series collection by category id","operationId":"getSeriesByCategory","description":"Get series collection by category id","produces":["application/json"],"parameters":[{"in":"path","name":"category_id","description":"ID of the category","type":"integer","format":"int32","required":true},{"in":"query","name":"skip","description":"number of records to skip for pagination","type":"integer","format":"int32","required":false,"default":0,"minimum":0},{"in":"query","name":"limit","description":"maximum number of records to return","type":"integer","format":"int32","required":false,"default":10,"minimum":1,"maximum":50}],"responses":{"200":{"description":"series data","schema":{"type":"array","items":{"$ref":"#/definitions/SeriesItem"}}},"400":{"description":"bad input parameter"}}}},"/author/{author_id}/series":{"get":{"tags":["series"],"summary":"get series collection by author id","operationId":"getSeriesByAuthor","description":"Get series collection by author id","produces":["application/json"],"parameters":[{"in":"path","name":"author_id","description":"ID of the author","type":"integer","format":"int32","required":true},{"in":"query","name":"skip","description":"number of records to skip for pagination","type":"integer","format":"int32","required":false,"default":0,"minimum":0},{"in":"query","name":"limit","description":"maximum number of records to return","type":"integer","format":"int32","required":false,"default":10,"minimum":1,"maximum":50}],"responses":{"200":{"description":"series data","schema":{"type":"array","items":{"$ref":"#/definitions/SeriesItem"}}},"400":{"description":"bad input parameter"}}}},"/my-series":{"get":{"tags":["series"],"summary":"get series collection authored by logged in user","operationId":"getMySeries","description":"Get series collection authored by logged in user","produces":["application/json"],"parameters":[{"in":"query","name":"skip","description":"number of records to skip for pagination","type":"integer","format":"int32","required":false,"default":0,"minimum":0},{"in":"query","name":"limit","description":"maximum number of records to return","type":"integer","format":"int32","required":false,"default":10,"minimum":1,"maximum":50}],"responses":{"200":{"description":"series data","schema":{"type":"array","items":{"$ref":"#/definitions/SeriesItem"}}},"403":{"description":"user not logged in"}}}},"/contact":{"post":{"tags":["contact"],"summary":"send feedack message","operationId":"sendFeedback","description":"Send feedback message to administrators","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"feedbackItem","description":"Feedback item to add","schema":{"$ref":"#/definitions/FeedbackItem"}}],"responses":{"201":{"description":"feedback created"}}}},"/search":{"get":{"tags":["search"],"summary":"perform search by tags","operationId":"getSearchTags","description":"Perform search by tags","produces":["application/json"],"parameters":[{"in":"query","name":"qt","description":"search by tag query string","type":"string","required":false}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SearchItem"}}}}}},"/search/history/{itemId}":{"put":{"tags":["search"],"summary":"change user search history item","operationId":"putSearchHistory","description":"Change user search history item","consumes":["application/json"],"parameters":[{"name":"itemId","in":"path","description":"Item ID","required":true,"type":"integer","format":"int64"},{"name":"tagItem","in":"body","description":"Tag item to change","schema":{"$ref":"#/definitions/SearchItem"}}],"responses":{"201":{"description":"item was changed"}}},"delete":{"tags":["search"],"summary":"delete tag from user search history","operationId":"deleteSearchHistory","description":"Delete tag from user history","consumes":["application/json"],"parameters":[{"name":"itemId","in":"path","description":"Item ID","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"tag deleted"}}}},"/search/history/":{"post":{"tags":["search"],"summary":"Add a new search item","operationId":"addSearchItem","description":"Add a new search item","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"item object","required":true,"schema":{"$ref":"#/definitions/SearchItem"}}],"responses":{"201":{"description":"item created"},"405":{"description":"Invalid input"}}}},"/desktops":{"get":{"tags":["desktops"],"summary":"get desktops - desktops created by logged user","operationId":"getDesktops","description":"Get desktops created by logged user if exists or predefined desktops","produces":["application/json"],"responses":{"200":{"description":"desktops data","schema":{"$ref":"#/definitions/DesktopsDetails"}},"400":{"description":"something wrong"}}},"post":{"tags":["desktops"],"summary":"Add a new desktop","operationId":"addDesktop","description":"Add a new desktop","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"desktop object","required":true,"schema":{"$ref":"#/definitions/DesktopData"}}],"responses":{"405":{"description":"Invalid input"}}}},"/desktops/{desktopId}":{"get":{"tags":["desktops"],"summary":"Get a desktop info","operationId":"getDesktop","produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"Desktop ID to delete","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"desktops data","schema":{"$ref":"#/definitions/DesktopData"}},"404":{"description":"Desktop not found"}}},"delete":{"tags":["desktops"],"summary":"Deletes a desktop","operationId":"deleteDesktop","produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"Desktop ID to delete","required":true,"type":"integer","format":"int64"}],"responses":{"400":{"description":"Invalid ID supplied"},"404":{"description":"Desktop not found"}}}},"/desktops-view/{desktopId}":{"get":{"tags":["desktops-view"],"summary":"get desktops collection to view (predefined or saved by logged user)","operationId":"getDesktopsView","produces":["application/json"],"responses":{"200":{"description":"desktops list","schema":{"type":"array","items":{"$ref":"#/definitions/DesktopItem"}}},"400":{"description":"something wrong"}}},"put":{"tags":["desktops-view"],"summary":"Add public desktop to collection view","operationId":"addDesktopToView","description":"Save public desktop in user's desktops view","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"Desktop ID to add","required":true,"type":"string"}],"responses":{"201":{"description":"Desktop added"},"403":{"description":"User not logged in"},"405":{"description":"Invalid input"}}},"delete":{"tags":["desktops-view"],"summary":"delete desktop from user desktops view","operationId":"deleteDesktopsFromView","description":"Delete desktop from user's desktops view","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"desktopId","in":"path","description":"Desktop ID to delete","required":true,"type":"string"}],"responses":{"204":{"description":"successful operation"},"403":{"description":"User not logged in"},"405":{"description":"Invalid input"}}}},"/bookmarks":{"get":{"tags":["bookmarks"],"summary":"get bookmarks (saved to favorites series, authors or photos) for logged in user","operationId":"getBookmarks","description":"Get bookmarks (saved to favorites series, authors or photos) for logged in user","produces":["application/json"],"responses":{"200":{"description":"bookmarks list","schema":{"$ref":"#/definitions/BookmarksList"}},"403":{"description":"user not logged in"}}},"post":{"tags":["bookmarks"],"summary":"Bookmark (add to favorites) a new item","operationId":"addBookmark","description":"Bookmark (add to favorites) a new item","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"data","description":"data of the object to add to favorites","required":true,"schema":{"$ref":"#/definitions/NewBookmarkData"}}],"responses":{"201":{"description":"Bookmark added"},"403":{"description":"User not logged in"},"405":{"description":"Invalid input"}}}}},"definitions":{"DesktopData":{"type":"object","required":["name"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique desktop ID"},"name":{"type":"string","description":"Desktop name","example":"Desktop"},"items":{"type":"array","description":"Array of items","items":{"$ref":"#/definitions/DesktopResourceItem"}}}},"DesktopResourceItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique ID of resource"},"name":{"type":"string","description":"Name of resource","example":"Norwegen"},"type":{"type":"string","description":"Type of resource","enum":["saved search","bookmark"]}}},"SearchItem":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique item ID"},"name":{"type":"string","description":"Tag name","example":"urban"},"type":{"type":"string","description":"Type of item","enum":["saved search","last search","search"]}}},"DesktopsDetails":{"type":"object","required":["has_more","desktopsList"],"properties":{"has_more":{"type":"boolean","description":"is there any other desktops on the server"},"desktopsList":{"type":"array","description":"list of desktops","items":{"$ref":"#/definitions/DesktopItem"}}}},"DesktopItem":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique desktop ID"},"name":{"type":"string","description":"Desktop name","example":"Desktop"},"series":{"type":"array","description":"Series preview in desktop","items":{"$ref":"#/definitions/SeriesItem"}}}},"FeedbackItem":{"type":"object","required":["message","email"],"properties":{"subject":{"type":"string","description":"Feeedback subject"},"message":{"type":"string","description":"Feeedback message"},"user":{"type":"string","description":"User name"},"email":{"type":"string","description":"User email"}}},"Tag":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique tag ID"},"name":{"type":"string","description":"Tag name","example":"urban"}}},"ImageItem":{"type":"object","required":["id","url"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique image ID","example":123},"type":{"type":"string","description":"Image MIME type","example":"image/jpg"},"title":{"type":"string","description":"Image title","example":"City image"},"width":{"type":"integer","format":"int32","description":"Image width","example":330},"height":{"type":"integer","format":"int32","description":"Image height","example":330},"url":{"type":"string","description":"Image source","example":"http://7pics/images/image123.jpg"}}},"SeriesItem":{"type":"object","required":["title"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique series item ID","example":123},"category_id":{"type":"integer","format":"int32","description":"Unique id of category the serie belongs to","example":123},"author_id":{"type":"integer","format":"int32","description":"Unique id of author of the serie","example":123},"title":{"type":"string","description":"Title of series item","example":"Architecture of the late 90ies"},"description":{"type":"string","description":"Description of series item","example":"the best hobby in the world"},"tags":{"type":"array","items":{"$ref":"#/definitions/Tag"}},"position":{"type":"integer","format":"int32","description":"Image position in series","example":4},"count":{"type":"integer","format":"int32","description":"Images count in series item","example":4},"image":{"$ref":"#/definitions/ImageItem","description":"Title image source"}}},"SeriesDetail":{"type":"object","required":["id","title"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique series item ID","example":123},"category_id":{"type":"integer","format":"int32","description":"Unique id of category the serie belongs to","example":123},"author_id":{"type":"integer","format":"int32","description":"Unique id of author of the serie","example":123},"parentSeriesLink":{"type":"string","description":"Link (route) to the parent series","example":"/series/1"},"title":{"type":"string","description":"Title of series item","example":"Architecture of the late 90ies"},"description":{"type":"string","description":"Description of series item","example":"the best hobby in the world"},"itemsCount":{"type":"integer","format":"int32","description":"Images count in series item","example":4},"items":{"type":"array","items":{"$ref":"#/definitions/SeriesDetailItem"}},"answers":{"type":"array","items":{"$ref":"#/definitions/SeriesItem"}}}},"SeriesDetailItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique image ID","example":123},"title":{"type":"string","description":"Title of image item","example":"Architecture of the late 90ies"},"description":{"type":"string","description":"Description of image item","example":"the best hobby in the world"},"url":{"type":"string","description":"Image source","example":"http://7pics/images/image123.jpg"},"comments":{"type":"array","items":{"$ref":"#/definitions/Comment"}}}},"Comment":{"type":"object","properties":{"title":{"type":"string"},"text":{"type":"string"}}},"User":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"},"phone":{"type":"string"}}},"CategoriesListPage":{"type":"object","required":["items"],"properties":{"nextPage":{"type":"integer","format":"int32","description":"Next page number, if available. Could be changed to next page link in future.","example":5},"items":{"type":"array","items":{"$ref":"#/definitions/CategoriesItem"}}}},"CategoriesItem":{"type":"object","required":["id","title"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique category ID","example":123},"title":{"type":"string","description":"Title of category","example":"Popular series"},"series":{"type":"array","items":{"$ref":"#/definitions/SeriesItem"}},"tags":{"type":"array","items":{"$ref":"#/definitions/Tag"}},"count":{"type":"integer","format":"int32","description":"Series count in category","example":4}}},"SeriesNew":{"type":"object","required":["type","series"],"properties":{"type":{"type":"string","description":"Type of series - story, question or challenge"},"parentId":{"type":"integer","format":"int64","description":"Unique parent series ID"},"series":{"type":"array","items":{"$ref":"#/definitions/SeriesItem"}}}},"RegisterUser":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string","description":"User's email"},"password":{"type":"string","description":"User's password"}}},"LoggedUser":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string","description":"User's email"},"password":{"type":"string","description":"User's password"}}},"ForgotPassword":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"User's email"}}},"ResetPassword":{"type":"object","required":["email","token"],"properties":{"email":{"type":"string","description":"User's email"},"token":{"type":"string","description":"token to reset password"}}},"BookmarksList":{"type":"array","description":"list of bookmarks","items":{"$ref":"#/definitions/BookmarksItem"}},"BookmarksItem":{"type":"object","required":["id","title","type","location"],"properties":{"id":{"type":"integer","format":"int32","description":"Unique bookmark ID","example":123},"title":{"type":"string","description":"Title of the bookmark - can be author, serie or photo title","example":"Skiing in Europe"},"type":{"type":"string","description":"Type of bookmarked item - can be serie, position (selected photo in the serie) or author","enum":["serie","photo","author"],"example":"serie"},"subject_id":{"type":"integer","format":"int64","description":"Unique ID if bookmarked item (serie_id, author_id or photo_id, depending on type)","example":2},"location":{"type":"string","description":"Route to open to navigate to bookmark","example":"/series/2#2"}}},"NewBookmarkData":{"type":"object","required":["type","serie_id"],"properties":{"serie_id":{"type":"integer","format":"int64","description":"Unique ID of the serie, which is base for adding bookmark. Real item to add can be the serie itself, specific photo in the serie (position), author of the serie, starter serie (topmost parent) for the serie, or author of the starter serie.","example":5},"photo_id":{"type":"integer","format":"int64","description":"Specific photo in the serie, if bookmarking position","example":3},"get_starter":{"type":"boolean","description":"If true, api should find and save to bookmarks starter serie or author","example":true},"type":{"type":"string","description":"Type of bookmarked item - can be serie, position (selected photo in the serie) or author","enum":["serie","photo","author"],"example":"serie"}}}}}