diff --git a/CHANGELOG.md b/CHANGELOG.md index dcb557f4..d192017e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,87 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased +### Visual changes + +- Move Older and Newer buttons on small screens to align their outer edges with the outer edges of the content above. Brings into line with larger screen sizes +- Always horizontally align like + save buttons with the stats tabs. Currently if there is an originally posted by the like + save buttons are aligned with that instead. Improves layout consistency and simplifies markup +- On posts that the user can edit the alt text is shown by default (the user doesn't have to toggle it visible). This simplifies the markup, styles, and javascript, and also helps to highlight to post authors if they have no alt text defined yet +- Moved the "remove from shake" button to be within the post header (used to be in the right hand gutter beside the header). Simpler markup and looks better +- Right aligned some buttons in the conversations view. Allows for a less cluttered layout without wasting heaps of vertical space + +### Use semantic tags on the outermost layers of most pages e.g. + +- `
` -> `
` +- `
` -> ` -
-
- +
diff --git a/src/areas/developer/examples/api-access.html b/src/areas/developer/examples/api-access.html index 6cb8cc1b..00058fc6 100644 --- a/src/areas/developer/examples/api-access.html +++ b/src/areas/developer/examples/api-access.html @@ -5,7 +5,7 @@
-
+

Allow Access?

Do you want to let this app read and write to your account?

@@ -23,6 +23,6 @@

Allow Access?

/>
-
+
diff --git a/src/areas/developer/examples/api-reference.html b/src/areas/developer/examples/api-reference.html index 0a9e94f4..d47fa690 100644 --- a/src/areas/developer/examples/api-reference.html +++ b/src/areas/developer/examples/api-reference.html @@ -5,2337 +5,2072 @@
- -
-
-
-
- -
-
-

- API Reference +

+ Serializations +

+

+ Responses from the MLTSHP API are + application/json responses that represent + the various MLTSHP API objects. Those objects are: +

+
+
+ shake +
+
+

+ A shake is a stream of files posted to MLTSHP by users. Shakes can + be user shakes, which every user has one of, or group shakes that + can have multiple posters. +

+ + + + + + + + + + + +
Contents: +
    +
  • + id – the shake’s numeric shake ID as a + number +
  • +
  • + name – the display title of the shake +
  • +
  • + owner – the + user + who created the shake +
  • +
  • + url – the URL of the shake on the + MLTSHP site +
  • +
  • + thumbnail_url – the URL of the shake’s + thumbnail logo image +
  • +
  • + description – the shake’s description + displayed under its logo on its page (optional) +
  • +
  • + type – the type of shake: either + user + or + group +
  • +
  • + created_at – the + time + when the shake was first created +
  • +
  • + updated_at – the + time + when the shake was last updated +
  • +
+
+
+
+
+
+ sharedfile +
+
+

+ A file that someone posted to a shake. A file can be either an + image or a link to a video. +

+ + + + + + + + + + + +
Contents: +
    +
  • + sharekey – the + sharekey + of the shared file +
  • +
  • + name – the filename of the shared file +
  • +
  • + user – the + user + who shared the file +
  • +
  • + title – the custom title the poster + gave the file (optional) +
  • +
  • + description – the caption displayed + under the file on its page (optional) +
  • +
  • + posted_at – the + time + the file was posted +
  • +
  • + permalink_page – the URL where the file + can be viewed on MLTSHP +
  • +
  • + width – the width of the file (image or + video embed) in pixels as a number +
  • +
  • + height – the height of the file (image + or video embed) in pixels as a number +
  • +
  • + views – the number of times the image + has been viewed +
  • +
  • + likes – the number of times the image + has been “liked” to someone’s favorites +
  • +
  • + saves – the number of times the image + has been saved to another shake +
  • +
  • + comments – the number of + comments + on the file +
  • +
  • + nsfw – whether the file has been marked + NSFW, and so is hidden by default when displayed on + MLTSHP (true for NSFW/hidden, + false for SFW/visible) +
  • +
  • + original_image_url – if the file is an + image, the URL of the image on MLTSHP +
  • +
  • + url – if the file is not an + image, the original URL of the shared item +
  • +
  • + pivot_id – a key that is used for + pagination. It varies based on the API method. +
  • +
  • + saved – flag indicating whether + authenticated user has already saved the sharedfile +
  • +
  • + liked – flag indicating whether + authenticated user has already liked the sharedfile +
  • +
+
+
+
+
+
+ sharekey +
+
+

+ The alphanumeric ID of a + sharedfile, such as + GK4N. These are the codes in the permalink page (and image URL) of + files posted to MLTSHP. +

+
+
+
+
+ timestamp +
+
+

+ Timestamps represent particular times when events occurred, such + as users posting files to shakes. Timestamps are always + represented in the MLTSHP API as ISO8601 timestamps in UTC (where + the timezone is + Z) with resolution to seconds (no microseconds). +

+
+
+
+
+ user +
+
+

+ A person with a MLTSHP account. Users own or manage shakes and + post files in them. +

+ + + + + + + + + + + +
Contents: +
    +
  • + id – the user’s numeric user ID as a + number +
  • +
  • name – the user’s username
  • +
  • + profile_image_url – the URL to the + user’s profile picture +
  • +
  • + about – a brief text blurb about the + user. Only available when querying the user resource. +
  • +
  • + website – the user’s URL. Only + available when querying the user resource. +
  • +
  • + shakes – the list of shakes that belong + to the user, including their main user shake. Only + available when querying the user resource. +
  • +
+
+
+
+
+
+ comment +
+
+

+ A traditional comment associated with a + sharedfile. +

+ + + + + + + + + + + +
Contents: +
    +
  • + body – the actual text body of the + comment +
  • +
  • + user – the + user + that posted the comment +
  • +
  • + posted_at – the + time + when the comment was posted +
  • +
+
+
+
+ +
+

+ Resources +

+

The resources (URL endpoints) in the MLTSHP API are:

+
+
+ GET /api/favorites +
+
+
+
+
+ GET /api/favorites/before/(beforekey) +
+
+
+
+
+ GET /api/favorites/after/(afterkey) +
+
+

+ Returns the files the authorized user has “liked” most recently + (or as specified). +

+

+ Use the + before/beforekey + and + after/afterkey + variations to page through the user’s favorites. That is, specify + the last + pivot_id as the key to the + before/beforekey + resource to get the page of files the user “liked” before the + current page. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • + beforekey – the + pivot_id of the + file to show posts before +
  • +
  • + afterkey – the + pivot_id of the + file to show posts after +
  • +
+
Status Codes: +
    +
  • + 200 OK + – +

    + the response is the requested section of the user’s + favorites as an object containing: +

    + +
  • +
+
+
+
+
+
+ GET /api/friends +
+
+
+
+
+ GET /api/friends/before/(beforekey) +
+
+
+
+
+ GET /api/friends/after/(afterkey) +
+
+

+ Returns the files posted most recently (or as specified) by the + users whom the authorized user follows. +

+

+ Use the + before/beforekey + and + after/afterkey + variations to page through the user’s friend shake. That is, to + request the next page of a friend shake, specify the last + pivot_id in the current page + as the key to a + /api/friends/before/beforekey + request. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • + beforekey – the + pivot_id of the + post to show posts before +
  • +
  • + afterkey – the + pivot_id of the + post to show posts after +
  • +
+
Status Codes: +
    +
  • + 200 OK + – +

    + the response is the requested section of friend shake + as an object containing: +

    + +
  • +
+
+
+
+
+
+ GET /api/magicfiles +
+
+
+
+
+ GET /api/magicfiles/before/(beforekey) +
+
+
+
+
+ GET /api/magicfiles/after/(afterkey) +
+
+

+ Returns the 10 most recent files accepted by the “magic” file + selection algorithm. Currently any files with 10 or more likes are + magic. +

+

+ Use the + before/beforekey + and + after/afterkey + variations to page through the sharedfiles. That is, specify the + last pivot_id as the key to + the + before/beforekey + resource to get the page of files saved before the current page. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • + beforekey – the + pivot_id of the + file to show posts before +
  • +
  • + afterkey – the + pivot_id of the + file to show posts after +
  • +
+
Status Codes: +
    +
  • + 200 OK + – +

    + the response is the latest magic files as an object + containing: +

    + +
  • +
+
+
+
+
+
+ GET /api/incoming +
+
+
+
+
+ GET /api/incoming/before/(beforekey) +
+
+
+
+
+ GET /api/incoming/after/(afterkey) +
+
+

Returns the 10 most recently posted sharedfiles.

+

+ Use the + before/beforekey + and + after/afterkey + variations to page through the sharedfiles. That is, specify the + last pivot_id as the key to + the + before/beforekey + resource to get the page of files saved before the current page. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • + beforekey – the + pivot_id of the + file to show posts before +
  • +
  • + afterkey – the + pivot_id of the + file to show posts after +
  • +
+
Status Codes: +
    +
  • + 200 OK + – +

    + the response is the latest files as an object + containing: +

    + +
  • +
+
+
+
+
+
+ GET /api/shakes/(id) +
+
+
+
+
+ GET /api/shakes/(id)/before/(beforekey) +
+
+
+
+
+ GET /api/shakes/(id)/after/(afterkey) +
+
+

+ Returns the sharedfiles for the specified shake in reverse + chronological order. +

+

+ Use the + before/beforekey + and + after/afterkey + variations to page through the sharefiles. That is, specify the + last pivot_id as the key to + the + before/beforekey + resource to get the page of files saved before the current page. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • + beforekey – the + pivot_id of the + file to show posts before +
  • +
  • + afterkey – the + pivot_id of the + file to show posts after +
  • +
+
Status Codes: +
    +
  • + 200 OK + – +

    + the response is the requested section of shake’s + sharedfiles: +

    + +
  • +
  • + 401 Unauthorized + – authentication failed +
  • +
+
+
+
+
+
+ GET /api/shake_id/(int: shakeid) +
+
+

+ Returns information for the shake with the given numeric shake ID. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • shakeid – the shake’s numeric ID
  • +
+
Status Codes: + +
+
+
+
+
+ GET /api/shake_name/(shakepathname) +
+
+

Returns information for the shake with the given pathname.

+

+ Note that name in this case refers to the URL path to the shake. + e.g., for + https://mltshp.com/weloveamberandandre + the pathname is weloveamberandandre. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • + shakepathname – the shake’s pathname +
  • +
+
Status Codes: + +
+
+
+
+
+ GET /api/shake_user/(username) +
+
+

+ Returns information for the shake belonging to the specified user. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • username – the user’s username
  • +
+
Status Codes: + +
+
+
+
+
+ GET /api/shakes +
+
+

Returns the authorized user’s shakes.

+ + + + + + + + + + + +
Status Codes: +
    +
  • + 200 OK + – +

    the response is an object containing:

    +
      +
    • + shakes – a list of the user’s + shakes +
    • +
    +
  • +
  • + 401 Unauthorized + – authentication failed +
  • +
+
+
+
+
+
+ GET /api/sharedfile/(sharekey) +
+
+

Returns information for the file with the given share key.

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • + sharekey – the + sharekey + of the file +
  • +
+
Status Codes: + +
+
+
+
+
+ POST /api/sharedfile/(sharekey) +
+
+

Update sharedfile’s editable details.

+ + + + + + + + + + + + + + + + + + + + + + +
Parameters: +
    +
  • + sharekey – the + sharekey + of the file +
  • +
+
Form Parameters:
  +
    +
  • + title – text for the image title + (optional) +
  • +
  • + description – text for the image + description (optional) +
  • +
+
Status Codes: +
    +
  • + 200 OK + – the response is a + sharedfile + for the requested file +
  • +
  • + 403 Forbidden + – the file could not be updated due to permission issues +
  • +
  • + 404 Not Found + – no such file with that share key +
  • +
+
+
+
+
+
+ POST /api/sharedfile/(sharekey)/like +
+
+

+ “Likes” the file with the given sharekey as the authorized user. + The file is then available in the user’s favorites. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • + sharekey – the + sharekey + of the file to like +
  • +
+
Status Codes: +
    +
  • + 200 OK + – the file was liked, and the response is the liked + sharedfile +
  • +
  • + 400 Bad Request + – the file could not be liked, probably because the + authorized user already liked it +
  • +
  • + 404 Not Found + – no such file with that share key +
  • +
+
+
+
+
+
+ POST /api/sharedfile/(sharekey)/save +
+
+

+ “Saves” the file with the given sharekey as the authorized user. + By default the file is saved to the user’s shake unless the + shake_id parameter is provided. +

+ + + + + + + + + + + + + + + + + + + + + + +
Parameters: +
    +
  • + sharekey – the + sharekey + of the file to save +
  • +
+
Form Parameters:
  +
    +
  • + shake_id – the id of the destination + shake + the file should be saved to (optional) +
  • +
+
Status Codes: +
    +
  • + 200 OK + – the file was saved, and the response is the saved + sharedfile +
  • +
  • + 400 Bad Request + – the file could not be saved, probably because the file + belongs to the authenticated user +
  • +
  • + 403 Forbidden + – the file could not be saved due to permission issues +
  • +
  • + 404 Not Found + – no such file with that share key or no such shake +
  • +
+
+
+
+
+
+ GET /api/sharedfile/(sharekey)/comments +
+
+

+ Returns a list of + comments - -

-

- Serializations -

-

- Responses from the MLTSHP API are - application/json responses that - represent the various MLTSHP API objects. Those objects are: -

-
-
- shake -
-
-

- A shake is a stream of files posted to MLTSHP by users. - Shakes can be user shakes, which every user has one of, or - group shakes that can have multiple posters. -

- - - - - - - - - - - -
Contents: -
    -
  • - id – the shake’s numeric shake ID - as a number -
  • -
  • - name – the display title of the - shake -
  • -
  • - owner – the - user - who created the shake -
  • -
  • - url – the URL of the shake on the - MLTSHP site -
  • -
  • - thumbnail_url – the URL of the - shake’s thumbnail logo image -
  • -
  • - description – the shake’s - description displayed under its logo on its page - (optional) -
  • -
  • - type – the type of shake: either - user - or - group -
  • -
  • - created_at – the - time - when the shake was first created -
  • -
  • - updated_at – the - time - when the shake was last updated -
  • -
-
-
-
-
-
- sharedfile -
-
-

- A file that someone posted to a shake. A file can be either - an image or a link to a video. -

- - - - - - - - - - - -
Contents: -
    -
  • - sharekey – the - sharekey - of the shared file -
  • -
  • - name – the filename of the shared - file -
  • -
  • - user – the - user - who shared the file -
  • -
  • - title – the custom title the - poster gave the file (optional) -
  • -
  • - description – the caption - displayed under the file on its page (optional) -
  • -
  • - posted_at – the - time - the file was posted -
  • -
  • - permalink_page – the URL where - the file can be viewed on MLTSHP -
  • -
  • - width – the width of the file - (image or video embed) in pixels as a number -
  • -
  • - height – the height of the file - (image or video embed) in pixels as a number -
  • -
  • - views – the number of times the - image has been viewed -
  • -
  • - likes – the number of times the - image has been “liked” to someone’s favorites -
  • -
  • - saves – the number of times the - image has been saved to another shake -
  • -
  • - comments – the number of - comments - on the file -
  • -
  • - nsfw – whether the file has been - marked NSFW, and so is hidden by default when - displayed on MLTSHP (true for - NSFW/hidden, false for SFW/visible) -
  • -
  • - original_image_url – if the file - is an image, the URL of the image on MLTSHP -
  • -
  • - url – if the file is - not an image, the original URL of the - shared item -
  • -
  • - pivot_id – a key that is used for - pagination. It varies based on the API method. -
  • -
  • - saved – flag indicating whether - authenticated user has already saved the - sharedfile -
  • -
  • - liked – flag indicating whether - authenticated user has already liked the - sharedfile -
  • -
-
-
-
-
-
- sharekey -
-
-

- The alphanumeric ID of a - sharedfile, such as - GK4N. These are the codes in the permalink page (and image URL) - of files posted to MLTSHP. -

-
-
-
-
- timestamp -
-
-

- Timestamps represent particular times when events occurred, - such as users posting files to shakes. Timestamps are always - represented in the MLTSHP API as ISO8601 timestamps in UTC - (where the timezone is - Z) with resolution to seconds (no microseconds). -

-
-
-
-
- user -
-
-

- A person with a MLTSHP account. Users own or manage shakes - and post files in them. -

- - - - - - - - - - - -
Contents: -
    -
  • - id – the user’s numeric user ID - as a number -
  • -
  • name – the user’s username
  • -
  • - profile_image_url – the URL to - the user’s profile picture -
  • -
  • - about – a brief text blurb about - the user. Only available when querying the user - resource. -
  • -
  • - website – the user’s URL. Only - available when querying the user resource. -
  • -
  • - shakes – the list of shakes that - belong to the user, including their main user - shake. Only available when querying the user - resource. -
  • -
-
-
-
-
-
- comment -
-
-

- A traditional comment associated with a - sharedfile. -

- - - - - - - - - - - -
Contents: -
    -
  • - body – the actual text body of - the comment -
  • -
  • - user – the - user - that posted the comment -
  • -
  • - posted_at – the - time - when the comment was posted -
  • -
-
-
-
-
-
-

- Resources -

-

The resources (URL endpoints) in the MLTSHP API are:

-
-
- GET /api/favorites -
-
-
-
-
- GET /api/favorites/before/(beforekey) -
-
-
-
-
- GET /api/favorites/after/(afterkey) -
-
-

- Returns the files the authorized user has “liked” most - recently (or as specified). -

-

- Use the - before/beforekey - and - after/afterkey - variations to page through the user’s favorites. That is, - specify the last - pivot_id as the key to - the - before/beforekey - resource to get the page of files the user “liked” before - the current page. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - beforekey – the - pivot_id of - the file to show posts before -
  • -
  • - afterkey – the - pivot_id of - the file to show posts after -
  • -
-
Status Codes: -
    -
  • - 200 OK - – -

    - the response is the requested section of the - user’s favorites as an object containing: -

    - -
  • -
-
-
-
-
-
- GET /api/friends -
-
-
-
-
- GET /api/friends/before/(beforekey) -
-
-
-
-
- GET /api/friends/after/(afterkey) -
-
-

- Returns the files posted most recently (or as specified) by - the users whom the authorized user follows. -

-

- Use the - before/beforekey - and - after/afterkey - variations to page through the user’s friend shake. That is, - to request the next page of a friend shake, specify the last - pivot_id in the current - page as the key to a - /api/friends/before/beforekey - request. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - beforekey – the - pivot_id of - the post to show posts before -
  • -
  • - afterkey – the - pivot_id of - the post to show posts after -
  • -
-
Status Codes: -
    -
  • - 200 OK - – -

    - the response is the requested section of friend - shake as an object containing: -

    - -
  • -
-
-
-
-
-
- GET /api/magicfiles -
-
-
-
-
- GET /api/magicfiles/before/(beforekey) -
-
-
-
-
- GET /api/magicfiles/after/(afterkey) -
-
-

- Returns the 10 most recent files accepted by the “magic” - file selection algorithm. Currently any files with 10 or - more likes are magic. -

-

- Use the - before/beforekey - and - after/afterkey - variations to page through the sharedfiles. That is, specify - the last pivot_id as - the key to the - before/beforekey - resource to get the page of files saved before the current - page. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - beforekey – the - pivot_id of - the file to show posts before -
  • -
  • - afterkey – the - pivot_id of - the file to show posts after -
  • -
-
Status Codes: -
    -
  • - 200 OK - – -

    - the response is the latest magic files as an - object containing: -

    - -
  • -
-
-
-
-
-
- GET /api/incoming -
-
-
-
-
- GET /api/incoming/before/(beforekey) -
-
-
-
-
- GET /api/incoming/after/(afterkey) -
-
-

Returns the 10 most recently posted sharedfiles.

-

- Use the - before/beforekey - and - after/afterkey - variations to page through the sharedfiles. That is, specify - the last pivot_id as - the key to the - before/beforekey - resource to get the page of files saved before the current - page. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - beforekey – the - pivot_id of - the file to show posts before -
  • -
  • - afterkey – the - pivot_id of - the file to show posts after -
  • -
-
Status Codes: -
    -
  • - 200 OK - – -

    - the response is the latest files as an object - containing: -

    - -
  • -
-
-
-
-
-
- GET /api/shakes/(id) -
-
-
-
-
- GET /api/shakes/(id)/before/(beforekey) -
-
-
-
-
- GET /api/shakes/(id)/after/(afterkey) -
-
-

- Returns the sharedfiles for the specified shake in reverse - chronological order. -

-

- Use the - before/beforekey - and - after/afterkey - variations to page through the sharefiles. That is, specify - the last pivot_id as - the key to the - before/beforekey - resource to get the page of files saved before the current - page. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - beforekey – the - pivot_id of - the file to show posts before -
  • -
  • - afterkey – the - pivot_id of - the file to show posts after -
  • -
-
Status Codes: -
    -
  • - 200 OK - – -

    - the response is the requested section of shake’s - sharedfiles: -

    - -
  • -
  • - 401 Unauthorized - – authentication failed -
  • -
-
-
-
-
-
- GET /api/shake_id/(int: shakeid) -
-
-

- Returns information for the shake with the given numeric - shake ID. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - shakeid – the shake’s numeric ID -
  • -
-
Status Codes: - -
-
-
-
-
- GET /api/shake_name/(shakepathname) -
-
-

- Returns information for the shake with the given pathname. -

-

- Note that name in this case refers to the URL path to the - shake. e.g., for - https://mltshp.com/weloveamberandandre - the pathname is weloveamberandandre. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - shakepathname – the shake’s - pathname -
  • -
-
Status Codes: - -
-
-
-
-
- GET /api/shake_user/(username) -
-
-

- Returns information for the shake belonging to the specified - user. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - username – the user’s username -
  • -
-
Status Codes: - -
-
-
-
-
- GET /api/shakes -
-
-

Returns the authorized user’s shakes.

- - - - - - - - - - - -
Status Codes: -
    -
  • - 200 OK - – -

    the response is an object containing:

    -
      -
    • - shakes – a list of the user’s - shakes -
    • -
    -
  • -
  • - 401 Unauthorized - – authentication failed -
  • -
-
-
-
-
-
- GET /api/sharedfile/(sharekey) -
-
-

- Returns information for the file with the given share key. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - sharekey – the - sharekey - of the file -
  • -
-
Status Codes: - -
-
-
-
-
- POST /api/sharedfile/(sharekey) -
-
-

Update sharedfile’s editable details.

- - - - - - - - - - - - - - - - - - - - - - -
Parameters: -
    -
  • - sharekey – the - sharekey - of the file -
  • -
-
Form Parameters:
  -
    -
  • - title – text for the image title - (optional) -
  • -
  • - description – text for the image - description (optional) -
  • -
-
Status Codes: -
    -
  • - 200 OK - – the response is a - sharedfile - for the requested file -
  • -
  • - 403 Forbidden - – the file could not be updated due to permission - issues -
  • -
  • - 404 Not Found - – no such file with that share key -
  • -
-
-
-
-
-
- POST /api/sharedfile/(sharekey)/like -
-
-

- “Likes” the file with the given sharekey as the authorized - user. The file is then available in the user’s favorites. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - sharekey – the - sharekey - of the file to like -
  • -
-
Status Codes: -
    -
  • - 200 OK - – the file was liked, and the response is the - liked - sharedfile -
  • -
  • - 400 Bad Request - – the file could not be liked, probably because - the authorized user already liked it -
  • -
  • - 404 Not Found - – no such file with that share key -
  • -
-
-
-
-
-
- POST /api/sharedfile/(sharekey)/save -
-
-

- “Saves” the file with the given sharekey as the authorized - user. By default the file is saved to the user’s shake - unless the shake_id parameter is provided. -

- - - - - - - - - - - - - - - - - - - - - - -
Parameters: -
    -
  • - sharekey – the - sharekey - of the file to save -
  • -
-
Form Parameters:
  -
    -
  • - shake_id – the id of the - destination - shake - the file should be saved to (optional) -
  • -
-
Status Codes: -
    -
  • - 200 OK - – the file was saved, and the response is the - saved - sharedfile -
  • -
  • - 400 Bad Request - – the file could not be saved, probably because - the file belongs to the authenticated user -
  • -
  • - 403 Forbidden - – the file could not be saved due to permission - issues -
  • -
  • - 404 Not Found - – no such file with that share key or no such - shake -
  • -
-
-
-
-
-
- GET /api/sharedfile/(sharekey)/comments -
-
-

- Returns a list of - comments - for the sharedfile with the given sharekey. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - sharekey – the - sharekey - of the file -
  • -
-
Status Codes: - -
-
-
-
-
- POST /api/sharedfile/(sharekey)/comments -
-
-

- Posts a new - comment - on behalf of the authenticated user to the - sharedfile - referenced with the given - sharekey. -

- - - - - - - - - - - - - - - - - - - - - - -
Parameters: -
    -
  • - sharekey – the - sharekey - of the file -
  • -
-
Form Parameters:
  -
    -
  • - body – the text contents of the - comment -
  • -
-
Status Codes: -
    -
  • - 404 Not Found - – no such file with that - sharekey - or no such shake -
  • -
  • - 400 Bad Request - – the comment could not be saved due to a missing - parameter or failed spam check -
  • -
  • - 200 OK - – the newly posted - comment - object -
  • -
-
-
-
-
-
- POST /api/upload -
-
-

- Adds the submitted image to a shake. Images should be - provided as - multipart/form-data request - bodies. -

- - - - - - - - - - - - - - - - - - -
Form Parameters:
  -
    -
  • - file – the file data of the image - to upload -
  • -
  • - shake_id – numeric ID of the - shake to post to (optional) -
  • -
  • - title – text for the image title - (optional) -
  • -
  • - description – text for the image - description (optional) -
  • -
-
Status Codes: -
    -
  • - 201 Created - – the image was posted to the shake, and the - response body is an abbreviated - sharedfile - representing it, containing only - sharekey - and name -
  • -
  • - 400 Bad Request - – the file could not be identified as an image -
  • -
-
-
-
-
-
- GET /api/user -
-
-

Returns the authorized user.

- - - - - - - - - - - -
Status Codes: -
    -
  • - 200 OK - – the response is the requested - user -
  • -
-
-
-
-
-
- GET /api/user_id/(int: userid) -
-
-

- Returns information for the user with the given numeric user - ID. -

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - userid (int) – the - user’s numeric ID -
  • -
-
Status Codes: - -
-
-
-
-
- GET /api/user_name/(username) -
-
-

Returns the user with the given username.

- - - - - - - - - - - - - - - -
Parameters: -
    -
  • - username – the user’s username -
  • -
-
Status Codes: - -
-
-
-
-
-
-
+ for the sharedfile with the given sharekey. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • + sharekey – the + sharekey + of the file +
  • +
+
Status Codes: + +
+ + +
+
+ POST /api/sharedfile/(sharekey)/comments +
+
+

+ Posts a new + comment + on behalf of the authenticated user to the + sharedfile + referenced with the given + sharekey. +

+ + + + + + + + + + + + + + + + + + + + + + +
Parameters: +
    +
  • + sharekey – the + sharekey + of the file +
  • +
+
Form Parameters:
  +
    +
  • + body – the text contents of the + comment +
  • +
+
Status Codes: +
    +
  • + 404 Not Found + – no such file with that + sharekey + or no such shake +
  • +
  • + 400 Bad Request + – the comment could not be saved due to a missing + parameter or failed spam check +
  • +
  • + 200 OK + – the newly posted + comment + object +
  • +
+
+
+
+
+
+ POST /api/upload +
+
+

+ Adds the submitted image to a shake. Images should be provided as + multipart/form-data request bodies. +

+ + + + + + + + + + + + + + + + + + +
Form Parameters:
  +
    +
  • + file – the file data of the image to + upload +
  • +
  • + shake_id – numeric ID of the shake to + post to (optional) +
  • +
  • + title – text for the image title + (optional) +
  • +
  • + description – text for the image + description (optional) +
  • +
+
Status Codes: +
    +
  • + 201 Created + – the image was posted to the shake, and the response + body is an abbreviated + sharedfile + representing it, containing only + sharekey + and name +
  • +
  • + 400 Bad Request + – the file could not be identified as an image +
  • +
+
+
+
+
+
+ GET /api/user +
+
+

Returns the authorized user.

+ + + + + + + + + + + +
Status Codes: +
    +
  • + 200 OK + – the response is the requested + user +
  • +
+
+
+
+
+
+ GET /api/user_id/(int: userid) +
+
+

+ Returns information for the user with the given numeric user ID. +

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • + userid (int) – the user’s + numeric ID +
  • +
+
Status Codes: + +
+
+
+
+
+ GET /api/user_name/(username) +
+
+

Returns the user with the given username.

+ + + + + + + + + + + + + + + +
Parameters: +
    +
  • username – the user’s username
  • +
+
Status Codes: + +
+
+
+
-
diff --git a/src/areas/faq/examples/faq.html b/src/areas/faq/examples/faq.html index b0a269d5..5ed03627 100644 --- a/src/areas/faq/examples/faq.html +++ b/src/areas/faq/examples/faq.html @@ -5,66 +5,63 @@
-
-
-

Frequently Asked Questions

+
+

Frequently Asked Questions

-

What is going on here?

-

- MLTSHP is an approximate clone of the much-loved site MLKSHK created - by Andre and Amber which closed in April of 2017. We - are 100% community funded and member-run. The site is - subscription-based and is a registered corporation. - The code is on Github along with - a welcome module there which talks about what is going - on. There is also a Slack (email hello@mltshp.com for - an invite!) and a Facebook group. -

+

What is going on here?

+

+ MLTSHP is an approximate clone of the much-loved site MLKSHK created by + Andre and Amber which closed in April of 2017. We are + 100% community funded and member-run. The site is subscription-based and + is a registered corporation. The code is on Github along + with a welcome module there which talks about what is + going on. There is also a Slack (email + hello@mltshp.com for an invite!) and + a Facebook group. +

-

What do the membership levels mean?

-

- Membership is required to participate on MLTSHP, but it‘s a low bar! - We‘d love to have you aboard! These are the options: -

-
    -
  • Non-members can see the Popular page and individual posts.
  • -
  • - The Single Scoop level ($3 per year) is a great way to check out the - site. Members can: -
      -
    • - Post images and videos to their own shakes and to group shakes, - up to a monthly upload limit of 300MB for images and animated - GIFs. -
    • -
    • - Follow their friends‘ shakes, and follow and join group shakes. -
    • -
    • Save, like, and comment on any posts.
    • -
    -
  • -
  • - The Double Scoop level ($24 per year) can do all of the above, plus: -
      -
    • There are no fixed upload limits.
    • -
    • Make up to 100 of their own group shakes.
    • -
    • Get a little plus sign next to their name.
    • -
    • Have RSS feeds for their shakes.
    • -
    - Even at just $2 per month, Double Scoop members cover the primary - expenses of running MLTSHP and help make the Single Scoop level - possible. -
  • -
-

- We ran some numbers and determined that with our current membership, - we could run the site if most users contributed $2/month. This - includes things like paying for storage, hosting, bandwidth, a - business license, someone to do our taxes and answer the odd legal - question we may have to ask. We added a “bare bones” membership - because we don‘t want anyone to be excluded. -

-
-
+

What do the membership levels mean?

+

+ Membership is required to participate on MLTSHP, but it‘s a low bar! + We‘d love to have you aboard! These are the options: +

+ +

+ We ran some numbers and determined that with our current membership, we + could run the site if most users contributed $2/month. This includes + things like paying for storage, hosting, bandwidth, a business license, + someone to do our taxes and answer the odd legal question we may have to + ask. We added a “bare bones” membership because we don‘t want anyone to + be excluded. +

+
diff --git a/src/areas/find-shakes/examples/find-people.html b/src/areas/find-shakes/examples/find-people.html index b6b88717..1a8890cd 100644 --- a/src/areas/find-shakes/examples/find-people.html +++ b/src/areas/find-shakes/examples/find-people.html @@ -5,13 +5,13 @@
-
-
+
- -
+
- + diff --git a/src/areas/find-shakes/examples/find-shakes.html b/src/areas/find-shakes/examples/find-shakes.html index 5551a497..3121b623 100644 --- a/src/areas/find-shakes/examples/find-shakes.html +++ b/src/areas/find-shakes/examples/find-shakes.html @@ -5,13 +5,13 @@
-
-
+
- -
+
-
+
diff --git a/src/areas/incoming/examples/incoming.html b/src/areas/incoming/examples/incoming.html index 19ad69fe..f4e36634 100644 --- a/src/areas/incoming/examples/incoming.html +++ b/src/areas/incoming/examples/incoming.html @@ -5,12 +5,12 @@
-
-
+
+

Our most recent files

-
+ -