## Server Skeleton A functional web api framework. ## GET /blogs ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### GET Parameters: - limit - **Values**: ** - **Description**: Maximum number of results to return - offset - **Values**: ** - **Description**: How many rows to skip - id - **Values**: ** - **Description**: It is of the form id[operator]=value where we have the following options: id[gt], id[lt], id[ge], id[le], id, id[!] - name - **Values**: ** - **Description**: It is of the form name[operator]=value where we have the following options: name[start], name[end], name[contains], name[match], name[!start], name[!end], name[!contains], name[!match], name[gt], name[lt], name[ge], name[le], name, name[!] - description - **Values**: ** - **Description**: It is of the form description[operator]=value where we have the following options: description[start], description[end], description[contains], description[match], description[!start], description[!end], description[!contains], description[!match], description[gt], description[lt], description[ge], description[le], description, description[!] - isextra - **Values**: ** - **Description**: It is of the form isextra[operator]=value where we have the following options: isextra, isextra[!] - ispublished - **Values**: ** - **Description**: It is of the form ispublished[operator]=value where we have the following options: ispublished, ispublished[!] - date - **Values**: ** - **Description**: It is of the form date[operator]=value where we have the following options: date[gt], date[lt], date[ge], date[le], date, date[!] ### Response: - Status code 200 - Headers: [("X-Total-Count",""),("Link",""),("Link","")] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - Example (`application/json;charset=utf-8`, `application/json`): ```javascript [] ``` ## POST /blogs ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Request: - Supported content types are: - `application/json;charset=utf-8` - `application/json` ### Response: - Status code 201 - Headers: [("Location","/user")] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - Example (`application/json;charset=utf-8`, `application/json`): ```javascript [] ``` ## DELETE /blogs/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Response: - Status code 204 - Headers: [] - No response body ## GET /blogs/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Response: - Status code 200 - Headers: [] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - No response body ## PATCH /blogs/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Request: - Supported content types are: - `application/json;charset=utf-8` - `application/json` ### Response: - Status code 204 - Headers: [] - No response body ## PUT /blogs/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Request: - Supported content types are: - `application/json;charset=utf-8` - `application/json` ### Response: - Status code 204 - Headers: [] - No response body ## POST /blogs/:id/createmails ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Response: - Status code 204 - Headers: [] - No response body ## GET /blogs/:id/files ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Response: - Status code 200 - Headers: [] - Supported content types are: - `image/bmp` - `image/gif` - `image/jpeg` - `image/png` - `image/tiff` - `image/vnd.radiance` - `image/x-targa` - No response body ## POST /blogs/:id/files ### Multipart Request Samples This endpoint takes `multipart/form-data` requests. The following is a list of sample requests: ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Response: - Status code 201 - Headers: [("Location","/user")] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - Example (`application/json;charset=utf-8`, `application/json`): ```javascript [] ``` ## DELETE /blogs/:id/files/:filename ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource - *filename*: The name of the requested file ### Response: - Status code 204 - Headers: [] - No response body ## PUT /blogs/:id/files/:filename ### Multipart Request Samples This endpoint takes `multipart/form-data` requests. The following is a list of sample requests: ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource - *filename*: The name of the requested file ### Response: - Status code 204 - Headers: [] - No response body ## POST /blogs/:id/sendmails ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Response: - Status code 204 - Headers: [] - No response body ## GET /mails ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### GET Parameters: - limit - **Values**: ** - **Description**: Maximum number of results to return - offset - **Values**: ** - **Description**: How many rows to skip - id - **Values**: ** - **Description**: It is of the form id[operator]=value where we have the following options: id[gt], id[lt], id[ge], id[le], id, id[!] - blog.id - **Values**: ** - **Description**: It is of the form blog.id[operator]=value where we have the following options: blog.id[gt], blog.id[lt], blog.id[ge], blog.id[le], blog.id, blog.id[!] - blog - **Values**: ** - **Description**: It is of the form blog[operator]=value where we have the following options: blog[start], blog[end], blog[contains], blog[match], blog[!start], blog[!end], blog[!contains], blog[!match], blog[gt], blog[lt], blog[ge], blog[le], blog, blog[!] - subscription.id - **Values**: ** - **Description**: It is of the form subscription.id[operator]=value where we have the following options: subscription.id[gt], subscription.id[lt], subscription.id[ge], subscription.id[le], subscription.id, subscription.id[!] - subscription - **Values**: ** - **Description**: It is of the form subscription[operator]=value where we have the following options: subscription[start], subscription[end], subscription[contains], subscription[match], subscription[!start], subscription[!end], subscription[!contains], subscription[!match], subscription[gt], subscription[lt], subscription[ge], subscription[le], subscription, subscription[!] - senddate - **Values**: ** - **Description**: It is of the form senddate[operator]=value where we have the following options: senddate[null], senddate[!null], senddate[gt], senddate[lt], senddate[ge], senddate[le], senddate, senddate[!] ### Response: - Status code 200 - Headers: [("X-Total-Count",""),("Link",""),("Link","")] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - Example (`application/json;charset=utf-8`, `application/json`): ```javascript [] ``` ## POST /mails ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Request: - Supported content types are: - `application/json;charset=utf-8` - `application/json` ### Response: - Status code 201 - Headers: [("Location","/user")] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - Example (`application/json;charset=utf-8`, `application/json`): ```javascript [] ``` ## DELETE /mails/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Response: - Status code 204 - Headers: [] - No response body ## GET /mails/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Response: - Status code 200 - Headers: [] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - No response body ## PATCH /mails/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Request: - Supported content types are: - `application/json;charset=utf-8` - `application/json` ### Response: - Status code 204 - Headers: [] - No response body ## PUT /mails/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Request: - Supported content types are: - `application/json;charset=utf-8` - `application/json` ### Response: - Status code 204 - Headers: [] - No response body ## GET /subscriptions ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### GET Parameters: - limit - **Values**: ** - **Description**: Maximum number of results to return - offset - **Values**: ** - **Description**: How many rows to skip - id - **Values**: ** - **Description**: It is of the form id[operator]=value where we have the following options: id[gt], id[lt], id[ge], id[le], id, id[!] - name - **Values**: ** - **Description**: It is of the form name[operator]=value where we have the following options: name[start], name[end], name[contains], name[match], name[!start], name[!end], name[!contains], name[!match], name[gt], name[lt], name[ge], name[le], name, name[!] - email - **Values**: ** - **Description**: It is of the form email[operator]=value where we have the following options: email[start], email[end], email[contains], email[match], email[!start], email[!end], email[!contains], email[!match], email[gt], email[lt], email[ge], email[le], email, email[!] - date - **Values**: ** - **Description**: It is of the form date[operator]=value where we have the following options: date[gt], date[lt], date[ge], date[le], date, date[!] - activated - **Values**: ** - **Description**: It is of the form activated[operator]=value where we have the following options: activated, activated[!] - key - **Values**: ** - **Description**: It is of the form key[operator]=value where we have the following options: key[start], key[end], key[contains], key[match], key[!start], key[!end], key[!contains], key[!match], key[gt], key[lt], key[ge], key[le], key, key[!] - unsubscribed - **Values**: ** - **Description**: It is of the form unsubscribed[operator]=value where we have the following options: unsubscribed, unsubscribed[!] ### Response: - Status code 200 - Headers: [("X-Total-Count",""),("Link",""),("Link","")] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - Example (`application/json;charset=utf-8`, `application/json`): ```javascript [] ``` ## POST /subscriptions ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Request: - Supported content types are: - `application/json;charset=utf-8` - `application/json` ### Response: - Status code 201 - Headers: [("Location","/user")] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - Example (`application/json;charset=utf-8`, `application/json`): ```javascript [] ``` ## DELETE /subscriptions/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Response: - Status code 204 - Headers: [] - No response body ## GET /subscriptions/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Response: - Status code 200 - Headers: [] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - No response body ## PATCH /subscriptions/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Request: - Supported content types are: - `application/json;charset=utf-8` - `application/json` ### Response: - Status code 204 - Headers: [] - No response body ## PUT /subscriptions/:id ### Authentication This part of the API is protected by the following authentication mechanisms: * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token)) Clients must supply the following data One of the following: * Cookies automatically set by browsers, plus a header * Cookies automatically set by browsers, plus a header * A JWT Token signed with this server's key ### Captures: - *id*: The primary key of the resource ### Request: - Supported content types are: - `application/json;charset=utf-8` - `application/json` ### Response: - Status code 204 - Headers: [] - No response body ## GET /subscriptions/:id/unsubscribe ### Captures: - *id*: The primary key of the resource ### GET Parameters: - key - **Values**: ** - **Description**: An authorization key ### Response: - Status code 200 - Headers: [] - Supported content types are: - `application/json;charset=utf-8` - `application/json` - `text/plain;charset=utf-8` - No response body